com.aspc.DBObj.Email

Class DBEmailAutoResponse

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailAutoResponse

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEmailAutoResponse
extends DBObject

Auto respond to a client.

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

Author:

Nigel Leck

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 Auto respond to a client
static java.lang.String	DBCLASS_NAME Auto respond to a client

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEmailAutoResponse	create(MutableDataSource mds) Make a new instance of this class.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
DBEmailAccount	findAccount(java.lang.String... args) The account the response will be sent from.
Person	findDisplayPerson(java.lang.String... args) The matching person to which the email will be (was) sent.
DBEmailTemplate	findDisplayTemplate(java.lang.String... args) The actual template if found.
static DBEmailAutoResponse	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBEmailAutoResponseStatus	findStatus(java.lang.String... args) The status of this response.
DBEmailAccount	getAccount(java.lang.String... args)
java.util.Date	getCreatedTime(java.lang.String... args)
Person	getDisplayPerson(java.lang.String... args)
DBEmailTemplate	getDisplayTemplate(java.lang.String... args)
java.lang.String	getFailureReason(java.lang.String... args)
java.lang.String	getFromEmail(java.lang.String... args)
int	getID(java.lang.String... args)
DBEmailAutoResponseStatus	getStatus(java.lang.String... args)
java.lang.String	getTemplateCode(java.lang.String... args)
java.lang.String	getTemplateJson(java.lang.String... args)
java.lang.String	getToEmail(java.lang.String... args)
static DBQuery<DBEmailAutoResponse>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBEmailAutoResponse	setAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
DBEmailAutoResponse	setCreatedTime(java.util.Date value, java.lang.String... args)
DBEmailAutoResponse	setFailureReason(java.lang.String value, java.lang.String... args)
DBEmailAutoResponse	setFromEmail(java.lang.String value, java.lang.String... args)
DBEmailAutoResponse	setID(int value, java.lang.String... args)
DBEmailAutoResponse	setStatus(com.aspc.dal.dbobj.email.DBEmailAutoResponseStatus value, java.lang.String... args)
DBEmailAutoResponse	setTemplateCode(java.lang.String value, java.lang.String... args)
DBEmailAutoResponse	setTemplateJson(java.lang.String value, java.lang.String... args)
DBEmailAutoResponse	setToEmail(java.lang.String 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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, 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

Auto respond to a client

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Auto respond to a client

Constructor Detail

DBEmailAutoResponse

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

Throws:

java.lang.Exception

getAccount

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

findAccount

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

The account the response will be sent from.

--> DBEmailAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setAccount

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

Throws:

java.lang.Exception

getCreatedTime

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

setCreatedTime

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

Throws:

java.lang.Exception

getDisplayPerson

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

findDisplayPerson

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

The matching person to which the email will be (was) sent.

--> Person (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

getDisplayTemplate

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

findDisplayTemplate

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

The actual template if found.

--> DBEmailTemplate (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

getFailureReason

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

setFailureReason

@Nonnull
public DBEmailAutoResponse setFailureReason(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getFromEmail

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

setFromEmail

@Nonnull
public DBEmailAutoResponse setFromEmail(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public DBEmailAutoResponseStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final DBEmailAutoResponseStatus findStatus(java.lang.String... args)
                                                                       throws NotFoundException

The status of this response.

--> DBEmailAutoResponseStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailAutoResponseStatus

Throws:

NotFoundException - DBEmailAutoResponseStatus was not found

setStatus

@Nonnull
public DBEmailAutoResponse setStatus(com.aspc.dal.dbobj.email.DBEmailAutoResponseStatus value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateCode

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

setTemplateCode

@Nonnull
public DBEmailAutoResponse setTemplateCode(@MatchesPattern(value="[a-zA-Z0-9_]+")
                                                    java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateJson

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

setTemplateJson

@Nonnull
public DBEmailAutoResponse setTemplateJson(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getToEmail

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

setToEmail

@Nonnull
public DBEmailAutoResponse setToEmail(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extGetDerivedGlobalKey

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

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.