com.aspc.workflow

Class DBAction

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBAction

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBActionCommand, DBActionCustom, DBActionFieldUpdate, DBAlertAction, DBSmsAction

public abstract class DBAction
extends DBObject

DBAction is an action to be performed as a result of an event in the system.

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 DBAction is an action to be performed as a result of an event in the system
static java.lang.String	DBCLASS_NAME DBAction is an action to be performed as a result of an event in the system

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBAction	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBActionType	findType(java.lang.String... args) The type of action.
java.lang.String	getCondition(java.lang.String... args)
java.lang.String	getDisplaySummary(java.lang.String... args)
DBEvent	getEvent() Returns Event that this validation group is for
int	getID(java.lang.String... args)
int	getSeq(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
DBActionType	getType(java.lang.String... args)
boolean	isApplicable(DBObject base) Determines if this action is applicable based on the state of the associated DBObject
boolean	isInactive(java.lang.String... args)
static DBQuery<DBAction>	makeQuery(DataSource ds) Make a new QUERY for this class.
abstract void	process(MutableDataSource mds, DBObject base) Performs the operations on the data source for this event
DBAction	setCondition(java.lang.String value, java.lang.String... args)
DBAction	setEvent(com.aspc.dal.workflow.DBEvent value, java.lang.String... args)
DBAction	setID(int value, java.lang.String... args)
DBAction	setInactive(boolean value, java.lang.String... args)
DBAction	setSeq(int value, java.lang.String... args)
DBAction	setSummary(java.lang.String value, java.lang.String... args)
DBAction	setType(com.aspc.dal.workflow.DBActionType 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, 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

DBAction is an action to be performed as a result of an event in the system

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBAction is an action to be performed as a result of an event in the system

Constructor Detail

DBAction

public DBAction(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 DBAction setID(int 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 DBAction 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)

setEvent

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

Throws:

java.lang.Exception

isInactive

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

setInactive

@Nonnull
public DBAction setInactive(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getSeq

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

setSeq

@Nonnull
public DBAction setSeq(int 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 DBAction setSummary(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public DBActionType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final DBActionType findType(java.lang.String... args)
                                                        throws NotFoundException

The type of action.

--> DBActionType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBActionType

Throws:

NotFoundException - DBActionType was not found

setType

@Nonnull
public DBAction setType(com.aspc.dal.workflow.DBActionType value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

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

process

public abstract void process(MutableDataSource mds,
                             DBObject base)
                      throws java.lang.Exception

Performs the operations on the data source for this event

Parameters:

mds - - MutableDataSource that action should be applied to

base - - Base Object that the event was raised for

Throws:

java.lang.Exception - - serious error

getEvent

public DBEvent getEvent()

Returns Event that this validation group is for

Returns:

DBEvent

isApplicable

public boolean isApplicable(DBObject base)
                     throws java.lang.Exception

Determines if this action is applicable based on the state of the associated DBObject

Parameters:

base - Base object to test the condition against

Returns:

boolean - true if validation should be checked

Throws:

java.lang.Exception - A serious problem