com.aspc.DBObj.Email

Class DBEmailTemplate

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailTemplate

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEmailTemplate
extends DBObject

Email Templates can be used to setup the format of Emails that can then be used multiple times.

Notes

Email Templates can be created with dynamic email components, such as personalized greetings, signatures, phone numbers etc.
These are produced by calling specifying a field path enclosed within dollar signs within the email body.

For example, to create a personalized greeting you could type:

Dear ${recipient.name,Sir/Madam},

This would create an email that reads:

Dear John Doe,

(if the name field was not filled in the record for the contact the Sir/Madam text would be substituted for the name of the contact)

Information can also be retrieved from the senders details by starting the path the prefix of "sender.".
For example.

Please contact ${sender.name} for more information

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

Since:

26 June 2002

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 Email Templates can be used to setup the format of Emails that can then be used multiple times.
static java.lang.String	DBCLASS_NAME Email Templates can be used to setup the format of Emails that can then be used multiple times.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBEmailTemplate(DBClass dbClass, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBEmailTemplate	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
protected void	extValidateRecord(ValidationList list) Text is mandatory if not file.
static DBEmailTemplate	findKey(DataSource ds, int key) Find the target for this class by the primary key
Contact	findReplyTo(java.lang.String... args) Reply To Person.
DBFile	findTemplateAttachment(java.lang.String... args) Attachment for the template.
java.lang.String	getBody(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getCss(java.lang.String... args)
int	getDaysLinkAttachmentAvailable(java.lang.String... args)
java.lang.String	getDisplayBody(java.lang.String... args)
java.lang.String	getHtmlBody(java.lang.String... args)
int	getID(java.lang.String... args)
Contact	getReplyTo(java.lang.String... args)
java.lang.String	getShortDescription(java.lang.String... args)
java.lang.String	getSubject(java.lang.String... args)
DBFile	getTemplateAttachment(java.lang.String... args)
boolean	isEmbedRemoteImages(java.lang.String... args)
boolean	isInactive(java.lang.String... args)
boolean	isLinkedAttachment(java.lang.String... args)
boolean	isSendCopyToSender(java.lang.String... args)
static DBQuery<DBEmailTemplate>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBEmailTemplate	setBody(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setCode(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setCss(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setDaysLinkAttachmentAvailable(int value, java.lang.String... args)
DBEmailTemplate	setEmbedRemoteImages(boolean value, java.lang.String... args)
DBEmailTemplate	setHtmlBody(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setID(int value, java.lang.String... args)
DBEmailTemplate	setInactive(boolean value, java.lang.String... args)
DBEmailTemplate	setLinkedAttachment(boolean value, java.lang.String... args)
DBEmailTemplate	setReplyTo(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBEmailTemplate	setSendCopyToSender(boolean value, java.lang.String... args)
DBEmailTemplate	setShortDescription(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setSubject(java.lang.String value, java.lang.String... args)
DBEmailTemplate	setTemplateAttachment(com.aspc.dal.file.DBFile 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, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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

Email Templates can be used to setup the format of Emails that can then be used multiple times.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Email Templates can be used to setup the format of Emails that can then be used multiple times.

Constructor Detail

DBEmailTemplate

public DBEmailTemplate(DBClass dbClass,
                       DataSource dataSource)
                throws java.lang.Exception

Std. DBObject constructor

Parameters:

dbClass - the class.

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

Throws:

java.lang.Exception

getBody

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

setBody

@Nonnull
public DBEmailTemplate setBody(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getCode

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

setCode

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

Throws:

java.lang.Exception

getCss

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

setCss

@Nonnull
public DBEmailTemplate setCss(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDaysLinkAttachmentAvailable

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

setDaysLinkAttachmentAvailable

@Nonnull
public DBEmailTemplate setDaysLinkAttachmentAvailable(int value,
                                                               java.lang.String... args)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayBody

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

isEmbedRemoteImages

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

setEmbedRemoteImages

@Nonnull
public DBEmailTemplate setEmbedRemoteImages(boolean value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlBody

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

setHtmlBody

@Nonnull
public DBEmailTemplate setHtmlBody(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isInactive

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

setInactive

@Nonnull
public DBEmailTemplate setInactive(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isLinkedAttachment

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

setLinkedAttachment

@Nonnull
public DBEmailTemplate setLinkedAttachment(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getReplyTo

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

findReplyTo

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

Reply To Person.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setReplyTo

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

Throws:

java.lang.Exception

isSendCopyToSender

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

setSendCopyToSender

@Nonnull
public DBEmailTemplate setSendCopyToSender(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getShortDescription

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

setShortDescription

@Nonnull
public DBEmailTemplate setShortDescription(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 DBEmailTemplate setSubject(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateAttachment

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

findTemplateAttachment

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

Attachment for the template.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setTemplateAttachment

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

Throws:

java.lang.Exception

create

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

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

The value of the field.

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

Additional business logic when a field is updated.

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

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class DBObject

Parameters:

field - the field

Returns:

is on change

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extValidateField

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

extValidateRecord

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

Text is mandatory if not file.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list

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

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem