com.aspc.workflow

Class DBEventCondition

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEventCondition

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEventCondition
extends DBObject

An Event Condition identifies if an Event should be raised. If there are multiple Conditions then the Event will be raised if any of these conditions are valid.
The checkOnCreate, checkOnModify and checkOnDelete control when this condition applies based on changes to an Object.
For the checkOnCreate and checkModify options the condition can be associated with multiple DBEventConditionField objects. This will cause the condition to be raised only when the value of these fields change.
The checkPeriodically is for conditions that are based on information not contained with the Object, i.e time of day
The condition is in a WHERE clause format and is optional when checkOnCreate, checkOnDelete and checkOnModify is selected.

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

Since:

15 June, 2004

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 An Event Condition identifies if an Event should be raised.
static java.lang.String	DBCLASS_NAME An Event Condition identifies if an 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
DBEventCondition(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBEventCondition	create(MutableDataSource mds) Make a new instance of this class.
java.lang.String	displayValue() Displays the value of the default display field
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBEvent	findEvent(java.lang.String... args) The EventGenerator is a background process which scans the system looking for DBObjects that match the condition specified for the Periodic Events.
static DBEventCondition	findKey(DataSource ds, int key) Find the target for this class by the primary key
java.lang.String	getCondition(java.lang.String... args)
java.lang.String	getDisplaySummary(java.lang.String... args)
DBEvent	getEvent(java.lang.String... args)
DBEventConditionField[]	getFieldConditions() Retrieves the list of field conditions for this condition
int	getID(java.lang.String... args)
java.lang.String	getScanInterval(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
boolean	isCheckOnCreate(java.lang.String... args)
boolean	isCheckOnDelete(java.lang.String... args)
boolean	isCheckOnModify(java.lang.String... args)
boolean	isCheckPeriodically(java.lang.String... args)
static DBQuery<DBEventCondition>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matches(DBObject base) Determines if the state of the supplied object matches this condition.
boolean	matchesFieldChange(DBObject base) If there is a list of DBFieldConditions that one of these fields has changed on the base object.
void	scan(VirtualDB vDB) Performs an event scan using the SYSTEM login.
void	scan(VirtualDB layer, Login login) Searches a database looking for objects which current state matches the condition.
DBEventCondition	setCheckOnCreate(boolean value, java.lang.String... args)
DBEventCondition	setCheckOnDelete(boolean value, java.lang.String... args)
DBEventCondition	setCheckOnModify(boolean value, java.lang.String... args)
DBEventCondition	setCheckPeriodically(boolean value, java.lang.String... args)
DBEventCondition	setCondition(java.lang.String value, java.lang.String... args)
DBEventCondition	setEvent(com.aspc.dal.workflow.DBEvent value, java.lang.String... args)
DBEventCondition	setID(int value, java.lang.String... args)
DBEventCondition	setScanInterval(java.lang.String value, java.lang.String... args)
DBEventCondition	setSummary(java.lang.String 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, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, 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

An Event Condition identifies if an Event should be raised. If there are multiple Conditions then the Event will be raised if any of these conditions are valid.
The checkOnCreate, checkOnModify and checkOnDelete control when this condition applies based on changes to an Object.
For the checkOnCreate and checkModify options the condition can be associated with multiple DBEventConditionField objects. This will cause the condition to be raised only when the value of these fields change.
The checkPeriodically is for conditions that are based on information not contained with the Object, i.e time of day
The condition is in a WHERE clause format and is optional when checkOnCreate, checkOnDelete and checkOnModify is selected.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

An Event Condition identifies if an Event should be raised. If there are multiple Conditions then the Event will be raised if any of these conditions are valid.
The checkOnCreate, checkOnModify and checkOnDelete control when this condition applies based on changes to an Object.
For the checkOnCreate and checkModify options the condition can be associated with multiple DBEventConditionField objects. This will cause the condition to be raised only when the value of these fields change.
The checkPeriodically is for conditions that are based on information not contained with the Object, i.e time of day
The condition is in a WHERE clause format and is optional when checkOnCreate, checkOnDelete and checkOnModify is selected.

Constructor Detail

DBEventCondition

public DBEventCondition(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 DBEventCondition setID(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isCheckOnCreate

@CheckReturnValue
public boolean isCheckOnCreate(java.lang.String... args)

setCheckOnCreate

@Nonnull
public DBEventCondition setCheckOnCreate(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isCheckOnDelete

@CheckReturnValue
public boolean isCheckOnDelete(java.lang.String... args)

setCheckOnDelete

@Nonnull
public DBEventCondition setCheckOnDelete(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isCheckOnModify

@CheckReturnValue
public boolean isCheckOnModify(java.lang.String... args)

setCheckOnModify

@Nonnull
public DBEventCondition setCheckOnModify(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isCheckPeriodically

@CheckReturnValue
public boolean isCheckPeriodically(java.lang.String... args)

setCheckPeriodically

@Nonnull
public DBEventCondition setCheckPeriodically(boolean value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getCondition

@CheckReturnValue
 @Nonnull
public java.lang.String getCondition(java.lang.String... args)

setCondition

@Nonnull
public DBEventCondition setCondition(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDisplaySummary

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplaySummary(java.lang.String... args)

getEvent

@CheckReturnValue
 @Nullable
public DBEvent getEvent(java.lang.String... args)

findEvent

@CheckReturnValue
 @Nonnull
public final DBEvent findEvent(java.lang.String... args)
                                                    throws NotFoundException

The EventGenerator is a background process which scans the system looking for DBObjects that match the condition specified for the Periodic Events. The processes occurs at a regular interval which by default is approximately every ten minutes. This ranges depending on the time it takes to process the scan.

--> DBEvent (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEvent

Throws:

NotFoundException - DBEvent was not found

setEvent

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

Throws:

java.lang.Exception

getScanInterval

@CheckReturnValue
 @Nonnull
public java.lang.String getScanInterval(java.lang.String... args)

setScanInterval

@Nonnull
public DBEventCondition setScanInterval(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSummary

@CheckReturnValue
 @Nonnull
public java.lang.String getSummary(java.lang.String... args)

setSummary

@Nonnull
public DBEventCondition setSummary(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBEventCondition 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<DBEventCondition> 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 DBEventCondition 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

scan

public void scan(@Nonnull
                 VirtualDB vDB)

Performs an event scan using the SYSTEM login.

Parameters:

vDB - the database to be scanned

displayValue

@CheckReturnValue
 @Nonnull
public java.lang.String displayValue()

Displays the value of the default display field

Overrides:

displayValue in class DBObject

Returns:

the display name

scan

public void scan(@Nonnull
                 VirtualDB layer,
                 @Nullable
                 Login login)

Searches a database looking for objects which current state matches the condition. When a match is found the Event is placed on the queue

Parameters:

layer - Database to be scanned

login - event generator login, can be null

matches

@CheckReturnValue
public boolean matches(@Nonnull
                                         DBObject base)
                                  throws java.lang.Exception

Determines if the state of the supplied object matches this condition.

Parameters:

base - Base object to check

Returns:

TRUE if object matches condition

Throws:

java.lang.Exception - Exception

matchesFieldChange

@CheckReturnValue
public boolean matchesFieldChange(@Nonnull
                                                    DBObject base)

If there is a list of DBFieldConditions that one of these fields has changed on the base object.

Parameters:

base - Base object used to check for field changes

Returns:

TRUE - there are not associated field conditions or one of the fields has changed

getFieldConditions

@CheckReturnValue
 @Nonnull
public DBEventConditionField[] getFieldConditions()

Retrieves the list of field conditions for this condition

Returns:

List of associated DBEventConditionField

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem