com.aspc.workflow

Class DBEvent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEvent

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEvent
extends DBObject

The DBEvent provides the core component of the workflow engine.
Events are raised when an Objects state matches the Event's conditions.
The Event's validations are then included in the validation of the changes to the Object and if all validations pass then the associated actions are performed.

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

Since:

29 May 2002

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 The DBEvent provides the core component of the workflow engine.
static java.lang.String	DBCLASS_NAME The DBEvent provides the core component of the workflow engine.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEvent	create(MutableDataSource mds) Make a new instance of this class.
protected void	extCheckDeleteAccess() Additional access checking for DELETE access for this object.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreSaveRecord() update the hasWorkflow fields.
static DBEvent	find(java.lang.String code, DataSource dataSource) finds a dbevent by its code
DBClassAbstract	findBaseClass(java.lang.String... args) The base class is the DBClass that this event belongs to.
DBFile	findDisplaySmallIcon(java.lang.String... args) Retrieves the icon to be displayed for this Event.
static DBEvent	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBMessage	findMessage(java.lang.String... args) The message used when notifying users of this event.
DBFile	findSmallIcon(java.lang.String... args) A 10X10 icon used to represent this event.
DBClassAbstract	getBaseClass(java.lang.String... args)
DBClassConcrete	getBaseClassConcrete() Returns the Base Class that this Event is for
java.lang.String	getCode(java.lang.String... args)
DBEventCondition[]	getConditions() Retrieves the list of conditions for this Event
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDisplayShortDesc(java.lang.String... args)
DBFile	getDisplaySmallIcon(java.lang.String... args)
DBMessage	getMessage(java.lang.String... args)
DBEvent[]	getPredecessors() Retrieves the list of conditions for this Event
java.lang.String	getReprocessInterval(java.lang.String... args)
DBFile	getSmallIcon(java.lang.String... args)
DBEventValidationGroup[]	getValidationGroups() Retrieves the list of validation groups for this Event
boolean	hasWorkflow(java.lang.String... args)
boolean	hasWorkflowMapping(java.lang.String... args)
boolean	isEventInactive(java.lang.String... args)
boolean	isInactive(java.lang.String... args)
boolean	isSavePeriodicalChangesOneByOne(java.lang.String... args)
boolean	isSkipObjectsInError(java.lang.String... args)
boolean	isTimer() Is this a timer event ?
static DBQuery<DBEvent>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matches(DBObject base) Determines if this conditions for this Event matches the current state of the supplied object
DBEvent	setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
DBEvent	setCode(java.lang.String value, java.lang.String... args)
DBEvent	setDescription(java.lang.String value, java.lang.String... args)
DBEvent	setEventInactive(boolean value, java.lang.String... args)
DBEvent	setHasWorkflowMapping(boolean value, java.lang.String... args)
DBEvent	setMessage(com.aspc.dal.message.DBMessage value, java.lang.String... args)
DBEvent	setReprocessInterval(java.lang.String value, java.lang.String... args)
DBEvent	setSavePeriodicalChangesOneByOne(boolean value, java.lang.String... args)
DBEvent	setSkipObjectsInError(boolean value, java.lang.String... args)
DBEvent	setSmallIcon(com.aspc.dal.file.DBFile 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, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

The DBEvent provides the core component of the workflow engine.
Events are raised when an Objects state matches the Event's conditions.
The Event's validations are then included in the validation of the changes to the Object and if all validations pass then the associated actions are performed.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The DBEvent provides the core component of the workflow engine.
Events are raised when an Objects state matches the Event's conditions.
The Event's validations are then included in the validation of the changes to the Object and if all validations pass then the associated actions are performed.

Constructor Detail

DBEvent

public DBEvent(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

getCode

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

setCode

@Nonnull
public DBEvent setCode(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getBaseClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getBaseClass(java.lang.String... args)

findBaseClass

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findBaseClass(java.lang.String... args)
                                                                throws NotFoundException

The base class is the DBClass that this event belongs to. This is rarely changes as the Conditions, Validations and Actions are normally based on fields on this class. In some cases this may be useful where the class structure has changed and it may be necessary to move the DBEvent to a parent class.

--> DBClassAbstract (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setBaseClass

@Nonnull
public DBEvent setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBEvent setDescription(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayShortDesc

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

getDisplaySmallIcon

@CheckReturnValue
 @Nullable
public DBFile getDisplaySmallIcon(java.lang.String... args)

findDisplaySmallIcon

@CheckReturnValue
 @Nonnull
public final DBFile findDisplaySmallIcon(java.lang.String... args)
                                                              throws NotFoundException

Retrieves the icon to be displayed for this Event. This is generally the icon from the associated message unless overridden for this event.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

isEventInactive

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

setEventInactive

@Nonnull
public DBEvent setEventInactive(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

hasWorkflow

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

hasWorkflowMapping

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

setHasWorkflowMapping

@Nonnull
public DBEvent setHasWorkflowMapping(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isInactive

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

getMessage

@CheckReturnValue
 @Nullable
public DBMessage getMessage(java.lang.String... args)

findMessage

@CheckReturnValue
 @Nonnull
public final DBMessage findMessage(java.lang.String... args)
                                                        throws NotFoundException

The message used when notifying users of this event.

--> DBMessage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Message

Throws:

NotFoundException - DBMessage was not found

setMessage

@Nonnull
public DBEvent setMessage(com.aspc.dal.message.DBMessage value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getReprocessInterval

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

setReprocessInterval

@Nonnull
public DBEvent setReprocessInterval(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isSavePeriodicalChangesOneByOne

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

setSavePeriodicalChangesOneByOne

@Nonnull
public DBEvent setSavePeriodicalChangesOneByOne(boolean value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

isSkipObjectsInError

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

setSkipObjectsInError

@Nonnull
public DBEvent setSkipObjectsInError(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSmallIcon

@CheckReturnValue
 @Nullable
public DBFile getSmallIcon(java.lang.String... args)

findSmallIcon

@CheckReturnValue
 @Nonnull
public final DBFile findSmallIcon(java.lang.String... args)
                                                       throws NotFoundException

A 10X10 icon used to represent this event. This will override the default message icon.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setSmallIcon

@Nonnull
public DBEvent setSmallIcon(com.aspc.dal.file.DBFile value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBEvent 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<DBEvent> 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 DBEvent findKey(@Nonnull
                                                          DataSource ds,
                                                          @Nonnull
                                                          java.lang.String 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

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for DELETE access for this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete this object

matches

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

Determines if this conditions for this Event matches the current state of the supplied object

Parameters:

base - Object that we are checking the state of

Returns:

true if the objects details matches all associated conditions

Throws:

java.lang.Exception - Exception

isTimer

public boolean isTimer()
                throws java.lang.Exception

Is this a timer event ?

Returns:

true if a timer

Throws:

java.lang.Exception - a serious problem

getConditions

public DBEventCondition[] getConditions()

Retrieves the list of conditions for this Event

Returns:

list of DBEventConditions

getPredecessors

public DBEvent[] getPredecessors()

Retrieves the list of conditions for this Event

Returns:

list of DBEventConditions

getValidationGroups

public DBEventValidationGroup[] getValidationGroups()

Retrieves the list of validation groups for this Event

Returns:

List of associated DBValidationGroups

getBaseClassConcrete

public DBClassConcrete getBaseClassConcrete()

Returns the Base Class that this Event is for

Returns:

DBClass that this Event is based on

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

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

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

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

update the hasWorkflow fields.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

find

public static DBEvent find(java.lang.String code,
                           DataSource dataSource)
                    throws java.lang.Exception

finds a dbevent by its code

Parameters:

code - the code of the event to find

dataSource - the datasource to look in

Returns:

DBEvent the event

Throws:

java.lang.Exception - a failure to find the event