com.aspc.workflow

Class DBEventPref

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEventPref

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEventPref
extends DBObject

DBEventPref Stores user preferences on how certain events should be processed.

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 Stores user preferences on how certain events should be processed.
static java.lang.String	DBCLASS_NAME Stores user preferences on how certain events should be processed.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEventPref	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected boolean	extIsOnChange(DBField field) Notifies processes that update fields that the specified field will update other fields when changed
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
DBEvent	findEvent(java.lang.String... args) Event.
static DBEventPref	findKey(DataSource ds, int key) Find the target for this class by the primary key
Person	findUser(java.lang.String... args) User.
int	getDisplayColor(java.lang.String... args)
DBEvent	getEvent(java.lang.String... args)
int	getID(java.lang.String... args)
Person	getUser(java.lang.String... args)
boolean	isDisplayFg(java.lang.String... args)
boolean	isEmailFg(java.lang.String... args)
boolean	isSmsFg(java.lang.String... args)
static DBQuery<DBEventPref>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBEventPref	setDisplayColor(int value, java.lang.String... args)
DBEventPref	setDisplayFg(boolean value, java.lang.String... args)
DBEventPref	setEmailFg(boolean value, java.lang.String... args)
DBEventPref	setEvent(com.aspc.dal.workflow.DBEvent value, java.lang.String... args)
DBEventPref	setID(int value, java.lang.String... args)
DBEventPref	setSmsFg(boolean value, java.lang.String... args)
DBEventPref	setUser(com.aspc.dal.dbobj.contact.Person 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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

Stores user preferences on how certain events should be processed.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Stores user preferences on how certain events should be processed.

Constructor Detail

DBEventPref

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

Throws:

java.lang.Exception

getDisplayColor

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

setDisplayColor

@Nonnull
public DBEventPref setDisplayColor(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isDisplayFg

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

setDisplayFg

@Nonnull
public DBEventPref setDisplayFg(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isEmailFg

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

setEmailFg

@Nonnull
public DBEventPref setEmailFg(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getEvent

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

findEvent

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

Event.

--> DBEvent (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEvent

Throws:

NotFoundException - DBEvent was not found

setEvent

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

Throws:

java.lang.Exception

isSmsFg

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

setSmsFg

@Nonnull
public DBEventPref setSmsFg(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getUser

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

findUser

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

User.

--> Person (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setUser

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

Throws:

java.lang.Exception

create

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

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Notifies processes that update fields that the specified field will update other fields when changed

Overrides:

extIsOnChange in class DBObject

Parameters:

field - - field to be updated

Returns:

- true if this field will updated others when changed

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem