com.aspc.distribution

Class EmailDistributionMethod

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.distribution.DistributionMethod

com.aspc.distribution.EmailDistributionMethod

All Implemented Interfaces:

SecondaryCacheGroup

public class EmailDistributionMethod
extends DistributionMethod

Email distribution method.

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

Since:

February 14, 2008, 1:28 AM

Author:

nabhilash

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 distribution method.
static java.lang.String	DBCLASS_NAME Email distribution method.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addRecipients(DBEmailSend es, MutableDataSource mds) add
void	doDistribution(MutableDataSource mds)
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
DBEmailAccount	findAccount(java.lang.String... args) Email account.
DBEmailSend	findEmailSend(java.lang.String... args) Email Send object created to distribute files.
DBEmailTemplate	findEmailTemplate(java.lang.String... args) Email template.
DBEmailAccount	getAccount(java.lang.String... args)
java.util.Date	getArticlePublishedDate(java.lang.String... args)
DBEmailSend	getEmailSend(java.lang.String... args)
DBEmailTemplate	getEmailTemplate(java.lang.String... args)
EmailDistributionRecipient[]	getRecipients() get the recipients
java.lang.String	getSubject(java.lang.String... args)
EmailDistributionMethod	setAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
EmailDistributionMethod	setArticlePublishedDate(java.util.Date value, java.lang.String... args)
EmailDistributionMethod	setEmailSend(com.aspc.dal.dbobj.email.internal.DBEmailSend value, java.lang.String... args)
EmailDistributionMethod	setEmailTemplate(com.aspc.dal.dbobj.email.DBEmailTemplate value, java.lang.String... args)
EmailDistributionMethod	setSubject(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.distribution.DistributionMethod

distribute, findContact, findKey, findStatus, findType, getContact, getDisplaySummary, getDistributedTS, getEdition, getErrorMsg, getID, getStatus, getType, makeQuery, setContact, setDistributedTS, setEdition, setErrorMsg, setID, setStatus, 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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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

Email distribution method.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Email distribution method.

Constructor Detail

EmailDistributionMethod

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

getAccount

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

findAccount

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

Email account.

--> DBEmailAccount (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setAccount

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

Throws:

java.lang.Exception

getArticlePublishedDate

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

setArticlePublishedDate

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

Throws:

java.lang.Exception

getEmailSend

@CheckReturnValue
 @Nullable
public DBEmailSend getEmailSend(java.lang.String... args)

findEmailSend

@CheckReturnValue
 @Nonnull
public final DBEmailSend findEmailSend(java.lang.String... args)
                                                            throws NotFoundException

Email Send object created to distribute files.

--> DBEmailSend (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailSend

Throws:

NotFoundException - DBEmailSend was not found

setEmailSend

@Nonnull
public EmailDistributionMethod setEmailSend(com.aspc.dal.dbobj.email.internal.DBEmailSend 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.

--> DBEmailTemplate (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

setEmailTemplate

@Nonnull
public EmailDistributionMethod setEmailTemplate(com.aspc.dal.dbobj.email.DBEmailTemplate 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 EmailDistributionMethod setSubject(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

doDistribution

public void doDistribution(MutableDataSource mds)
                    throws java.lang.Exception

Overrides:

doDistribution in class DistributionMethod

Parameters:

mds - the data source

Throws:

java.lang.Exception - a serious problem

addRecipients

protected void addRecipients(DBEmailSend es,
                             MutableDataSource mds)
                      throws java.lang.Exception

add

Parameters:

es - email

mds - the data source

Throws:

java.lang.Exception - a serious problem

getRecipients

public EmailDistributionRecipient[] getRecipients()

get the recipients

Returns:

the list of recipients

extAutoEnterCreate

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

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate 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

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 DistributionMethod

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

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Additional functionality when an object is copied.

Overrides:

extCopy in class DBObject

Parameters:

target - the target object

Throws:

java.lang.Exception - a serious problem

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 value for this derived field

Throws:

java.lang.Exception - A serious problem