com.aspc.workflow

Class DBAlertAction

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBAction

com.aspc.workflow.DBAlertAction

All Implemented Interfaces:

SecondaryCacheGroup

public class DBAlertAction
extends DBAction

DBAlertAction generates an alert as a result of an event in the system
The Alert Action is the most commonly used action as it will generate a DBAlert which can be used to notify a user or group when a particular Event has been triggered through Email, SMS or application interface.

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 The Alert Action is the most commonly used action as it will generate a DBAlert which can be used to notify a user or group when a particular Event has been triggered through Email, SMS or application interface.
static java.lang.String	DBCLASS_NAME The Alert Action is the most commonly used action as it will generate a DBAlert which can be used to notify a user or group when a particular Event has been triggered through Email, SMS or application interface.
static java.lang.String	DISABLE_ALERTS_ATT If value set as attribute on datasource then alerts will not be processed

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Additional functionality when an object is created.
DBFile	findDisplayIcon(java.lang.String... args) Icon used to represent this event.
DBEmailAccount	findEmailSenderAccount(java.lang.String... args) Specifies the account that the email should be sent from.
DBEmailTemplate	findEmailTemplate(java.lang.String... args) Email Template used to send the email alert.
DBAlertLevel	findLevel(java.lang.String... args) Level of the Alert.
int	getDisplayColor(java.lang.String... args)
java.lang.String	getDisplayFormat(java.lang.String... args)
DBFile	getDisplayIcon(java.lang.String... args)
java.lang.String	getDisplayTitle(java.lang.String... args)
java.lang.String	getEmailHTMLFormat(java.lang.String... args)
DBEmailAccount	getEmailSenderAccount(java.lang.String... args)
java.lang.String	getEmailSubjectFormat(java.lang.String... args)
DBEmailTemplate	getEmailTemplate(java.lang.String... args)
java.lang.String	getEmailTextFormat(java.lang.String... args)
DBAlertLevel	getLevel(java.lang.String... args)
Contact[]	getRecipients(DBObject base) Retrieves the list of recipients that are to receive the alerts
java.lang.String	getReplyToEmail(java.lang.String... args)
java.lang.String	getSmsFormat(java.lang.String... args)
java.lang.String	getSmsTextFormat(java.lang.String... args)
boolean	isAllowSuperUserAccess(java.lang.String... args)
boolean	isDisplayFg(java.lang.String... args)
boolean	isEmailFg(java.lang.String... args)
boolean	isExcludeNonUsers(java.lang.String... args)
boolean	isExcludeSender(java.lang.String... args)
boolean	isSmsFg(java.lang.String... args)
void	process(MutableDataSource mds, DBObject base) Process this action by creating an alert for each recipient
DBAlertAction	setAllowSuperUserAccess(boolean value, java.lang.String... args)
DBAlertAction	setDisplayColor(int value, java.lang.String... args)
DBAlertAction	setDisplayFg(boolean value, java.lang.String... args)
DBAlertAction	setDisplayFormat(java.lang.String value, java.lang.String... args)
DBAlertAction	setDisplayIcon(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBAlertAction	setDisplayTitle(java.lang.String value, java.lang.String... args)
DBAlertAction	setEmailFg(boolean value, java.lang.String... args)
DBAlertAction	setEmailHTMLFormat(java.lang.String value, java.lang.String... args)
DBAlertAction	setEmailSenderAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
DBAlertAction	setEmailSubjectFormat(java.lang.String value, java.lang.String... args)
DBAlertAction	setEmailTemplate(com.aspc.dal.dbobj.email.DBEmailTemplate value, java.lang.String... args)
DBAlertAction	setEmailTextFormat(java.lang.String value, java.lang.String... args)
DBAlertAction	setExcludeNonUsers(boolean value, java.lang.String... args)
DBAlertAction	setExcludeSender(boolean value, java.lang.String... args)
DBAlertAction	setLevel(com.aspc.dal.workflow.DBAlertLevel value, java.lang.String... args)
DBAlertAction	setReplyToEmail(java.lang.String value, java.lang.String... args)
DBAlertAction	setSmsFg(boolean value, java.lang.String... args)
DBAlertAction	setSmsFormat(java.lang.String value, java.lang.String... args)
DBAlertAction	setSmsTextFormat(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.workflow.DBAction

findKey, findType, getCondition, getDisplaySummary, getEvent, getID, getSeq, getSummary, getType, isApplicable, isInactive, makeQuery, setCondition, setEvent, setID, setInactive, setSeq, setSummary, setType

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, 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

The Alert Action is the most commonly used action as it will generate a DBAlert which can be used to notify a user or group when a particular Event has been triggered through Email, SMS or application interface.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The Alert Action is the most commonly used action as it will generate a DBAlert which can be used to notify a user or group when a particular Event has been triggered through Email, SMS or application interface.

DISABLE_ALERTS_ATT

public static final java.lang.String DISABLE_ALERTS_ATT

If value set as attribute on datasource then alerts will not be processed

See Also:

Constant Field Values

Constructor Detail

DBAlertAction

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

isAllowSuperUserAccess

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

setAllowSuperUserAccess

@Nonnull
public DBAlertAction setAllowSuperUserAccess(boolean 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 DBAlertAction 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 DBAlertAction setDisplayFg(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayFormat

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

setDisplayFormat

@Nonnull
public DBAlertAction setDisplayFormat(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayIcon

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

findDisplayIcon

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

Icon used to represent this event.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setDisplayIcon

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

Throws:

java.lang.Exception

getDisplayTitle

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

setDisplayTitle

@Nonnull
public DBAlertAction setDisplayTitle(java.lang.String 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 DBAlertAction setEmailFg(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getEmailHTMLFormat

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

setEmailHTMLFormat

@Nonnull
public DBAlertAction setEmailHTMLFormat(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getEmailSenderAccount

@CheckReturnValue
 @Nullable
public DBEmailAccount getEmailSenderAccount(java.lang.String... args)

findEmailSenderAccount

@CheckReturnValue
 @Nonnull
public final DBEmailAccount findEmailSenderAccount(java.lang.String... args)
                                                                        throws NotFoundException

Specifies the account that the email should be sent from. This overrides the default which will be the default account of the person who triggered the action. This option is most often used when an alert is sent externally to a client and a company email address should be used rather then the users email address.

--> DBEmailAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setEmailSenderAccount

@Nonnull
public DBAlertAction setEmailSenderAccount(com.aspc.dal.dbobj.email.DBEmailAccount value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getEmailSubjectFormat

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

setEmailSubjectFormat

@Nonnull
public DBAlertAction setEmailSubjectFormat(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getEmailTemplate

@CheckReturnValue
 @Nullable
public DBEmailTemplate getEmailTemplate(java.lang.String... args)

findEmailTemplate

@CheckReturnValue
 @Nonnull
public final DBEmailTemplate findEmailTemplate(java.lang.String... args)
                                                                    throws NotFoundException

Email Template used to send the email alert.

--> DBEmailTemplate (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

setEmailTemplate

@Nonnull
public DBAlertAction setEmailTemplate(com.aspc.dal.dbobj.email.DBEmailTemplate value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getEmailTextFormat

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

setEmailTextFormat

@Nonnull
public DBAlertAction setEmailTextFormat(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

isExcludeNonUsers

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

setExcludeNonUsers

@Nonnull
public DBAlertAction setExcludeNonUsers(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

isExcludeSender

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

setExcludeSender

@Nonnull
public DBAlertAction setExcludeSender(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getLevel

@CheckReturnValue
 @Nullable
public DBAlertLevel getLevel(java.lang.String... args)

findLevel

@CheckReturnValue
 @Nonnull
public final DBAlertLevel findLevel(java.lang.String... args)
                                                         throws NotFoundException

Level of the Alert.

--> DBAlertLevel (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Alert Level

Throws:

NotFoundException - DBAlertLevel was not found

setLevel

@Nonnull
public DBAlertAction setLevel(com.aspc.dal.workflow.DBAlertLevel value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getReplyToEmail

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

setReplyToEmail

@Nonnull
public DBAlertAction setReplyToEmail(java.lang.String 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 DBAlertAction setSmsFg(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSmsFormat

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

setSmsFormat

@Nonnull
public DBAlertAction setSmsFormat(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSmsTextFormat

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

setSmsTextFormat

@Nonnull
public DBAlertAction setSmsTextFormat(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

process

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

Process this action by creating an alert for each recipient

Specified by:

process in class DBAction

Parameters:

mds - - Datasource to create the alerts in

base - - object that the alert was based on

Throws:

java.lang.Exception - - a serious error

getRecipients

public Contact[] getRecipients(DBObject base)
                        throws java.lang.Exception

Retrieves the list of recipients that are to receive the alerts

Parameters:

base - - DBObject that alert is based on

Returns:

- list of recipients

Throws:

java.lang.Exception - - a serious error