com.aspc.workflow

Class DBAlert

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBAlert

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBManualAlert

public class DBAlert
extends DBObject

DBAlert provides a mechanism for notifying people of certain events
Stores details of an event so that it can be presented to the user by the selected means.

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 java.lang.String	DBALERT_STATUS_NONE No action required for alert
static java.lang.String	DBALERT_STATUS_SEND Alert needs to be sent
static GlobalId	DBCLASS_GID Stores details of an event so that it can be presented to the user by the selected means.
static java.lang.String	DBCLASS_NAME Stores details of an event so that it can be presented to the user by the selected means.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBAlert(DBClass theClass, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
void	allowSuperUserAccess(boolean flag)
boolean	checkStillValid() Determines if the Alert is still valid, i.e does it still apply
static DBAlert	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 void	extFixUp() The extended fix up routine for known problems.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPostSaveRecord(long transNr) Additional functionality AFTER saving this record to the database.
protected void	extPreSaveRecord() Additional functionality WHILE saving this record to the database.
DBAlertAction	findAlertAction(java.lang.String... args) Alert Action.
DBAlertAction	findCalcAlertAction(java.lang.String... args) Handles backward compatability where only action details were contained in event.
Person	findDisplayFor(java.lang.String... args) Who sees this alert.
DBFile	findDisplayIcon(java.lang.String... args) Icon to display.
DBEmailAccount	findEmailSenderAccount(java.lang.String... args) Specifies the email account that should be used to send the email from.
DBEmailTemplate	findEmailTemplate(java.lang.String... args) Email Template used to send the email alert.
DBEvent	findEvent(java.lang.String... args) Event.
static DBAlert	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBAlertLevel	findLevel(java.lang.String... args) Level of the alert.
Contact	findRecipient(java.lang.String... args) Recipient.
Person	findSender(java.lang.String... args) Person who generated the alert.
DBAlertType	findType(java.lang.String... args) Type of the alert.
DBAlertAction	getAlertAction(java.lang.String... args)
DBAlertAction	getCalcAlertAction(java.lang.String... args)
java.lang.String	getDbObjectKey(java.lang.String... args)
java.lang.String	getDisplayChangesHTML(java.lang.String... args)
Person	getDisplayFor(java.lang.String... args)
DBFile	getDisplayIcon(java.lang.String... args)
java.lang.String	getDisplayMessage(java.lang.String... args)
java.lang.String	getDisplayTitle(java.lang.String... args)
java.lang.String	getEmailHTMLMessage(java.lang.String... args)
java.lang.String	getEmailReplyToEmail(java.lang.String... args)
DBEmailAccount	getEmailSenderAccount(java.lang.String... args)
java.lang.String	getEmailSubject(java.lang.String... args)
DBEmailTemplate	getEmailTemplate(java.lang.String... args)
java.lang.String	getEmailTextMessage(java.lang.String... args)
java.util.Date	getEnteredTime(java.lang.String... args)
DBEvent	getEvent(java.lang.String... args)
int	getID(java.lang.String... args)
DBAlertLevel	getLevel(java.lang.String... args)
java.lang.String	getMessage(java.lang.String... args)
java.lang.String	getNewObjectChanges(DBObject base, MutableDataSource mds, java.util.List logControls, DBObject[] assocPaths) Returns the reasons why objects have changed
Contact	getRecipient(java.lang.String... args)
Person	getSender(java.lang.String... args)
java.lang.String	getSenderEmail(Contact pRecipient) This method is public only for testing sender email in this sequence: 1.
java.lang.String	getSentById(java.lang.String... args)
java.lang.String	getSmsMessage(java.lang.String... args)
java.lang.String	getStatus(java.lang.String... args)
java.lang.String	getSubject(java.lang.String... args)
DBAlertType	getType(java.lang.String... args)
boolean	isSendEmailFg(java.lang.String... args)
boolean	isSendSMSFg(java.lang.String... args)
boolean	isSendToDisplayFg(java.lang.String... args)
boolean	isViewed(java.lang.String... args)
static DBQuery<DBAlert>	makeQuery(DataSource ds) Make a new QUERY for this class.
protected void	sendAlert(long transNr) Send out an email and or sms for this alert
DBAlert	setAlertAction(com.aspc.dal.workflow.DBAlertAction value, java.lang.String... args)
DBAlert	setDbObjectKey(java.lang.String value, java.lang.String... args)
DBAlert	setDisplayFor(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBAlert	setDisplayIcon(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBAlert	setEmailSenderAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
DBAlert	setEnteredTime(java.util.Date value, java.lang.String... args)
DBAlert	setEvent(com.aspc.dal.workflow.DBEvent value, java.lang.String... args)
DBAlert	setID(int value, java.lang.String... args)
DBAlert	setLevel(com.aspc.dal.workflow.DBAlertLevel value, java.lang.String... args)
DBAlert	setMessage(java.lang.String value, java.lang.String... args)
DBAlert	setRecipient(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBAlert	setSendEmailFg(boolean value, java.lang.String... args)
DBAlert	setSender(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBAlert	setSendSMSFg(boolean value, java.lang.String... args)
DBAlert	setSendToDisplayFg(boolean value, java.lang.String... args)
DBAlert	setSentById(java.lang.String value, java.lang.String... args)
DBAlert	setStatus(java.lang.String value, java.lang.String... args)
DBAlert	setSubject(java.lang.String value, java.lang.String... args)
DBAlert	setType(com.aspc.dal.workflow.DBAlertType value, java.lang.String... args)
DBAlert	setViewed(boolean 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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, 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

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Stores details of an event so that it can be presented to the user by the selected means.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Stores details of an event so that it can be presented to the user by the selected means.

DBALERT_STATUS_NONE

public static final java.lang.String DBALERT_STATUS_NONE

No action required for alert

See Also:

Constant Field Values

DBALERT_STATUS_SEND

public static final java.lang.String DBALERT_STATUS_SEND

Alert needs to be sent

See Also:

Constant Field Values

Constructor Detail

DBAlert

public DBAlert(@Nonnull
               DBClass theClass,
               @Nonnull
               DataSource dataSource)
        throws java.lang.Exception

Std. DBObject constructor.

Parameters:

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

Throws:

java.lang.Exception

getAlertAction

@CheckReturnValue
 @Nullable
public DBAlertAction getAlertAction(java.lang.String... args)

findAlertAction

@CheckReturnValue
 @Nonnull
public final DBAlertAction findAlertAction(java.lang.String... args)
                                                                throws NotFoundException

Alert Action.

--> DBAlertAction (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBAlertAction

Throws:

NotFoundException - DBAlertAction was not found

setAlertAction

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

Throws:

java.lang.Exception

getCalcAlertAction

@CheckReturnValue
 @Nullable
public DBAlertAction getCalcAlertAction(java.lang.String... args)

findCalcAlertAction

@CheckReturnValue
 @Nonnull
public final DBAlertAction findCalcAlertAction(java.lang.String... args)
                                                                    throws NotFoundException

Handles backward compatability where only action details were contained in event.

--> DBAlertAction (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBAlertAction

Throws:

NotFoundException - DBAlertAction was not found

getDbObjectKey

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

setDbObjectKey

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

Throws:

java.lang.Exception

getDisplayChangesHTML

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

getDisplayFor

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

findDisplayFor

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

Who sees this alert.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setDisplayFor

@Nonnull
public DBAlert setDisplayFor(com.aspc.dal.dbobj.contact.Person 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 to display.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setDisplayIcon

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

Throws:

java.lang.Exception

getDisplayMessage

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

getDisplayTitle

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

getEmailHTMLMessage

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

getEmailReplyToEmail

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

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 email account that should be used to send the email from.

--> DBEmailAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setEmailSenderAccount

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

Throws:

java.lang.Exception

getEmailSubject

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

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, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

getEmailTextMessage

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

getEnteredTime

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

setEnteredTime

@Nonnull
public DBAlert setEnteredTime(java.util.Date 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, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEvent

Throws:

NotFoundException - DBEvent was not found

setEvent

@Nonnull
public DBAlert setEvent(com.aspc.dal.workflow.DBEvent 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 DBAlert setLevel(com.aspc.dal.workflow.DBAlertLevel value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

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

setMessage

@Nonnull
public DBAlert setMessage(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getRecipient

@CheckReturnValue
 @Nullable
public Contact getRecipient(java.lang.String... args)

findRecipient

@CheckReturnValue
 @Nonnull
public final Contact findRecipient(java.lang.String... args)
                                                        throws NotFoundException

Recipient.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setRecipient

@Nonnull
public DBAlert setRecipient(com.aspc.dal.dbobj.contact.Contact value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isSendEmailFg

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

setSendEmailFg

@Nonnull
public DBAlert setSendEmailFg(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isSendSMSFg

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

setSendSMSFg

@Nonnull
public DBAlert setSendSMSFg(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isSendToDisplayFg

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

setSendToDisplayFg

@Nonnull
public DBAlert setSendToDisplayFg(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSender

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

findSender

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

Person who generated the alert.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setSender

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

Throws:

java.lang.Exception

getSentById

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

setSentById

@Nonnull
public DBAlert setSentById(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSmsMessage

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

getStatus

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

setStatus

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

Throws:

java.lang.Exception

getSubject

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

setSubject

@Nonnull
public DBAlert setSubject(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getType

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

findType

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

Type of the alert.

--> DBAlertType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Alert Type

Throws:

NotFoundException - DBAlertType was not found

setType

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

Throws:

java.lang.Exception

isViewed

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

setViewed

@Nonnull
public DBAlert setViewed(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

create

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

checkStillValid

@CheckReturnValue
public boolean checkStillValid()

Determines if the Alert is still valid, i.e does it still apply

Returns:

- true if Alert is still valid

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

getNewObjectChanges

public java.lang.String getNewObjectChanges(@Nonnull
                                            DBObject base,
                                            @Nonnull
                                            MutableDataSource mds,
                                            @Nullable
                                            java.util.List logControls,
                                            @Nullable
                                            DBObject[] assocPaths)
                                     throws java.lang.Exception

Returns the reasons why objects have changed

Parameters:

base - object

mds - Current datasource

logControls - List of log controls

assocPaths - List of associated paths to alternate objects to include in list of change reasons

Returns:

The updated reason

Throws:

java.lang.Exception - If something went wrong

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

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

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

getSenderEmail

public java.lang.String getSenderEmail(@Nullable
                                       Contact pRecipient)

This method is public only for testing sender email in this sequence: 1. use alert sender 2. use alert email sender account 3. use global default alert sender account 4. use global company's email 5. use recipient's email

Parameters:

pRecipient -

Returns:

sendAlert

protected void sendAlert(@Nonnegative
                         long transNr)

Send out an email and or sms for this alert

Parameters:

transNr - Transaction number from when alert was created

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

allowSuperUserAccess

public void allowSuperUserAccess(boolean flag)

Parameters:

flag - the flag.

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Additional functionality AFTER saving this record to the database.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - This transaction number that was just saved.