com.aspc.workflow

Class DBSmsAction

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBAction

com.aspc.workflow.DBSmsAction

All Implemented Interfaces:

SecondaryCacheGroup

public class DBSmsAction
extends DBAction

DBSmsAction generates SMS This SMS message action will generate SMS.

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

Since:

24 May 2012

Author:

Liam Itzhaki

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 This SMS message action will generate SMS
static java.lang.String	DBCLASS_NAME This SMS message action will generate SMS

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Additional functionality when an object is created.
java.lang.String	getMessageTemplate(java.lang.String... args)
java.lang.String	getRecipientField(java.lang.String... args)
void	process(MutableDataSource mds, DBObject base) Process this action by creating an alert for each recipient
DBSmsAction	setMessageTemplate(java.lang.String value, java.lang.String... args)
DBSmsAction	setRecipientField(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

This SMS message action will generate SMS

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

This SMS message action will generate SMS

Constructor Detail

DBSmsAction

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

getMessageTemplate

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

setMessageTemplate

@Nonnull
public DBSmsAction setMessageTemplate(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientField

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

setRecipientField

@Nonnull
public DBSmsAction setRecipientField(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