com.aspc.workflow

Class DBEventQueue

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEventQueue

All Implemented Interfaces:

SecondaryCacheGroup, EventMarker

public class DBEventQueue
extends DBObject
implements EventMarker

DBEventQueue records details of when events were raised.

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 DBEventQueue records details of when events were raised
static java.lang.String	DBCLASS_NAME DBEventQueue records details of when events were raised
static java.lang.String	STATUS_PROCESSED All actions have been processed
static java.lang.String	STATUS_WAITING_PROCESSING The actions for this Event have not been processed

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEventQueue	create(MutableDataSource mds) Make a new instance of this class.
protected void	extAutoEnterCreate() Sets the default status to waiting to be processed
protected void	extFixUp() The extended fix up routine for known problems.
protected void	extPreSaveRecord() Additional functionality WHILE saving this record to the database.
Person	findEnteredBy(java.lang.String... args) Entered By.
static DBEventQueue	findKey(DataSource ds, int key) Find the target for this class by the primary key
java.lang.String	getBaseKey() get the base object key
DBObject	getBaseObject() Returns the associated base object
java.lang.String	getDbObjectKey(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnterTime(java.lang.String... args)
DBEvent	getEvent() Returns the associated event
java.lang.String	getEventKey() get the event key
int	getID(java.lang.String... args)
java.lang.String	getStatus(java.lang.String... args)
java.lang.String	makeKey() make a key
static DBQuery<DBEventQueue>	makeQuery(DataSource ds) Make a new QUERY for this class.
static void	process(MutableDataSource mds, EventMarker marker) Process all actions associated with this Event
void	setBaseObject(DBObject base) set's the base object
DBEventQueue	setDbObjectKey(java.lang.String value, java.lang.String... args)
DBEventQueue	setEnteredBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBEventQueue	setEnterTime(java.util.Date value, java.lang.String... args)
DBEventQueue	setEvent(com.aspc.dal.workflow.DBEvent value, java.lang.String... args)
DBEventQueue	setID(int value, java.lang.String... args)
DBEventQueue	setRowId(long value, java.lang.String... args)
DBEventQueue	setStatus(java.lang.String value, java.lang.String... args)
static void	validateEvent(MutableDataSource mds, EventMarker marker, ValidationList list) Loop through each validation group.

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetDerivedValue, 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

STATUS_WAITING_PROCESSING

public static final java.lang.String STATUS_WAITING_PROCESSING

The actions for this Event have not been processed

See Also:

Constant Field Values

STATUS_PROCESSED

public static final java.lang.String STATUS_PROCESSED

All actions have been processed

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

DBEventQueue records details of when events were raised

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBEventQueue records details of when events were raised

Constructor Detail

DBEventQueue

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

Throws:

java.lang.Exception

getDbObjectKey

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

setDbObjectKey

@Nonnull
public DBEventQueue setDbObjectKey(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getEnterTime

@CheckReturnValue
public java.util.Date getEnterTime(java.lang.String... args)

setEnterTime

@Nonnull
public DBEventQueue setEnterTime(java.util.Date value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public DBEventQueue setEnteredBy(com.aspc.dal.dbobj.contact.Person value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

setEvent

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

Throws:

java.lang.Exception

setRowId

@Nonnull
public DBEventQueue setRowId(long value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

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

setStatus

@Nonnull
public DBEventQueue setStatus(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

create

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

makeKey

public java.lang.String makeKey()

make a key

Specified by:

makeKey in interface EventMarker

Returns:

the unique key for this marker

getBaseKey

public java.lang.String getBaseKey()

get the base object key

Specified by:

getBaseKey in interface EventMarker

Returns:

the unique key for the base object

getEventKey

public java.lang.String getEventKey()

get the event key

Specified by:

getEventKey in interface EventMarker

Returns:

the event key

extAutoEnterCreate

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

Sets the default status to waiting to be processed

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

validateEvent

public static void validateEvent(@Nonnull
                                 MutableDataSource mds,
                                 @Nonnull
                                 EventMarker marker,
                                 @Nonnull
                                 ValidationList list)
                          throws java.lang.Exception

Loop through each validation group. If any groups pass then validation will pass since the groups are treated as ORs

Parameters:

mds - the data source

marker - the marker

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

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

Additional functionality WHILE saving this record to the database.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A serious problem

getEvent

public DBEvent getEvent()

Returns the associated event

Specified by:

getEvent in interface EventMarker

Returns:

DBEvent

process

public static void process(@Nonnull
                           MutableDataSource mds,
                           @Nonnull
                           EventMarker marker)
                    throws java.lang.Exception

Process all actions associated with this Event

Parameters:

mds - the data source

marker - the marker

Throws:

java.lang.Exception - Exception

getBaseObject

public DBObject getBaseObject()
                       throws java.lang.Exception

Returns the associated base object

Specified by:

getBaseObject in interface EventMarker

Returns:

DBObject that matches base key

Throws:

java.lang.Exception - Exception

setBaseObject

public void setBaseObject(DBObject base)

set's the base object

Parameters:

base - the base object

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem