com.aspc.workflow

Class DBEventConditionField

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEventConditionField

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEventConditionField
extends DBObject

Specifies that when the value of a field changes then the Event should be raised.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

29 Aug, 2005

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Specifies that when the value of a field changes then the Event should be raised.
static java.lang.String	DBCLASS_NAME Specifies that when the value of a field changes then the Event should be raised.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBEventConditionField(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBEventConditionField	create(MutableDataSource mds) Make a new instance of this class.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
DBEventCondition	findEventCondition(java.lang.String... args) The associated event condition.
DBField	findField(java.lang.String... args) The field that should be checked to see if the value has been changed.
static DBEventConditionField	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBEventCondition	getEventCondition(java.lang.String... args)
DBField	getField(java.lang.String... args)
int	getID(java.lang.String... args)
static DBQuery<DBEventConditionField>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matches(DBObject base) Determines if the value for the associated field has changed a Object
DBEventConditionField	setEventCondition(com.aspc.dal.workflow.DBEventCondition value, java.lang.String... args)
DBEventConditionField	setField(com.aspc.dal.dbobj.DBField value, java.lang.String... args)
DBEventConditionField	setID(int value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Specifies that when the value of a field changes then the Event should be raised.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Specifies that when the value of a field changes then the Event should be raised.

Constructor Detail

DBEventConditionField

public DBEventConditionField(DBClass def,
                             DataSource dataSource)
                      throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBEventConditionField setID(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getEventCondition

@CheckReturnValue
 @Nullable
public DBEventCondition getEventCondition(java.lang.String... args)

findEventCondition

@CheckReturnValue
 @Nonnull
public final DBEventCondition findEventCondition(java.lang.String... args)
                                                                      throws NotFoundException

The associated event condition.

--> DBEventCondition (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEventCondition

Throws:

NotFoundException - DBEventCondition was not found

setEventCondition

@Nonnull
public DBEventConditionField setEventCondition(com.aspc.dal.workflow.DBEventCondition value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getField

@CheckReturnValue
 @Nullable
public DBField getField(java.lang.String... args)

findField

@CheckReturnValue
 @Nonnull
public final DBField findField(java.lang.String... args)
                                                    throws NotFoundException

The field that should be checked to see if the value has been changed.

--> DBField (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

setField

@Nonnull
public DBEventConditionField setField(com.aspc.dal.dbobj.DBField value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBEventConditionField create(@Nonnull
                                                                       MutableDataSource mds)
                                                                throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBEventConditionField> makeQuery(@Nonnull
                                                                                   DataSource ds)
                                                                            throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBEventConditionField findKey(@Nonnull
                                                                        DataSource ds,
                                                                        int key)
                                                                 throws NotFoundException,
                                                                        java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extValidateField

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

matches

public boolean matches(DBObject base)

Determines if the value for the associated field has changed a Object

Parameters:

base - Object that we are checking the values for

Returns:

true if the field value has changed