com.aspc.DBObj.Email

Class DBEmailRecipient

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailRecipient

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBEmailRecipient

public class DBEmailRecipient
extends DBObject

Identifies a recipient of the Email message.

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 Identifies a recipient of the Email message.
static java.lang.String	DBCLASS_NAME Identifies a recipient of the Email message.
static java.lang.String	RECIPIENT_TYPE

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEmailRecipient	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBEmail	findEmailId(java.lang.String... args) Email Id.
Person	findEnteredBy(java.lang.String... args) Entered By.
static DBEmailRecipient	findKey(DataSource ds, int key) Find the target for this class by the primary key
Contact	findRecipient(java.lang.String... args) Recipient.
DBLanguage	findRecipientLanguage(java.lang.String... args) The language setting on the machine that the email was read from.
DBEmailSendStatus	findSendStatus(java.lang.String... args) The status of the sending of the email to this recipient.
DBEmailRecipientType	findType(java.lang.String... args) Type.
java.lang.String	getDisplayRecipient(java.lang.String... args)
java.lang.String	getEmail(java.lang.String... args)
DBEmail	getEmailId(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.lang.String	getFailTx(java.lang.String... args)
int	getID(java.lang.String... args)
java.util.Date	getReadDate(java.lang.String... args)
Contact	getRecipient(java.lang.String... args)
java.lang.String	getRecipientAddr(java.lang.String... args)
DBLanguage	getRecipientLanguage(java.lang.String... args)
java.lang.String	getRecipientOSName(java.lang.String... args)
DBEmailSendStatus	getSendStatus(java.lang.String... args)
java.util.Date	getSentDate(java.lang.String... args)
DBEmailRecipientType	getType(java.lang.String... args)
boolean	isGroupEmail(java.lang.String... args)
boolean	isMatchesSender(java.lang.String... args)
boolean	isReceivedEmail(java.lang.String... args)
boolean	isSentEmail(java.lang.String... args)
static DBQuery<DBEmailRecipient>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBEmailRecipient	setEmail(java.lang.String value, java.lang.String... args)
DBEmailRecipient	setEmailId(com.aspc.dal.dbobj.email.DBEmail value, java.lang.String... args)
DBEmailRecipient	setEnteredBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBEmailRecipient	setFailTx(java.lang.String value, java.lang.String... args)
DBEmailRecipient	setGroupEmail(boolean value, java.lang.String... args)
DBEmailRecipient	setID(int value, java.lang.String... args)
DBEmailRecipient	setReadDate(java.util.Date value, java.lang.String... args)
DBEmailRecipient	setRecipient(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBEmailRecipient	setRecipientAddr(java.lang.String value, java.lang.String... args)
DBEmailRecipient	setRecipientLanguage(com.aspc.dal.dbobj.language.DBLanguage value, java.lang.String... args)
DBEmailRecipient	setRecipientOSName(java.lang.String value, java.lang.String... args)
DBEmailRecipient	setSendStatus(com.aspc.dal.dbobj.email.DBEmailSendStatus value, java.lang.String... args)
DBEmailRecipient	setSentDate(java.util.Date value, java.lang.String... args)
DBEmailRecipient	setType(com.aspc.dal.dbobj.email.DBEmailRecipientType value, java.lang.String... args)
static boolean	useEmailBillToAddress(DataSource ds, DBEmailSend dBEmailSend) Check if the DBEmailRecipient.email should be set to Contact.emailBillTo
protected void	validateSubType(DBField field, java.lang.Object value) http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

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, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

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

Identifies a recipient of the Email message.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Identifies a recipient of the Email message.

RECIPIENT_TYPE

public static final java.lang.String RECIPIENT_TYPE

See Also:

Constant Field Values

Constructor Detail

DBEmailRecipient

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

Throws:

java.lang.Exception

getDisplayRecipient

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

getEmail

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

setEmail

@Nonnull
public DBEmailRecipient setEmail(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getEmailId

@CheckReturnValue
 @Nullable
public DBEmail getEmailId(java.lang.String... args)

findEmailId

@CheckReturnValue
 @Nonnull
public final DBEmail findEmailId(java.lang.String... args)
                                                      throws NotFoundException

Email Id.

--> DBEmail (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email

Throws:

NotFoundException - DBEmail was not found

setEmailId

@Nonnull
public DBEmailRecipient setEmailId(com.aspc.dal.dbobj.email.DBEmail value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredBy

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

findEnteredBy

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

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setEnteredBy

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

Throws:

java.lang.Exception

getFailTx

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

setFailTx

@Nonnull
public DBEmailRecipient setFailTx(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isGroupEmail

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

setGroupEmail

@Nonnull
public DBEmailRecipient setGroupEmail(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

isReceivedEmail

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

isSentEmail

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

isMatchesSender

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

getReadDate

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

setReadDate

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

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setRecipient

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

Throws:

java.lang.Exception

getRecipientAddr

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

setRecipientAddr

@Nonnull
public DBEmailRecipient setRecipientAddr(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientLanguage

@CheckReturnValue
 @Nullable
public DBLanguage getRecipientLanguage(java.lang.String... args)

findRecipientLanguage

@CheckReturnValue
 @Nonnull
public final DBLanguage findRecipientLanguage(java.lang.String... args)
                                                                   throws NotFoundException

The language setting on the machine that the email was read from.

--> DBLanguage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Language

Throws:

NotFoundException - DBLanguage was not found

setRecipientLanguage

@Nonnull
public DBEmailRecipient setRecipientLanguage(com.aspc.dal.dbobj.language.DBLanguage value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientOSName

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

setRecipientOSName

@Nonnull
public DBEmailRecipient setRecipientOSName(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getSendStatus

@CheckReturnValue
 @Nullable
public DBEmailSendStatus getSendStatus(java.lang.String... args)

findSendStatus

@CheckReturnValue
 @Nonnull
public final DBEmailSendStatus findSendStatus(java.lang.String... args)
                                                                   throws NotFoundException

The status of the sending of the email to this recipient.

--> DBEmailSendStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailSendStatus

Throws:

NotFoundException - DBEmailSendStatus was not found

setSendStatus

@Nonnull
public DBEmailRecipient setSendStatus(com.aspc.dal.dbobj.email.DBEmailSendStatus value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSentDate

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

setSentDate

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

Throws:

java.lang.Exception

getType

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

findType

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

Type.

--> DBEmailRecipientType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Recipient Type

Throws:

NotFoundException - DBEmailRecipientType was not found

setType

@Nonnull
public DBEmailRecipient setType(com.aspc.dal.dbobj.email.DBEmailRecipientType value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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()

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to be notified when a field changes. This method should not trigger a save of this record because you may save a record in a half updated state.
TODO: Put in a programmer check for a save during this method call.

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

validateSubType

protected void validateSubType(@Nonnull
                               DBField field,
                               @Nullable
                               java.lang.Object value)
                        throws InvalidDataException,
                               InvalidDataWarning

Description copied from class: DBObject

http://www.regular-expressions.info/email.html http://tools.ietf.org/html/rfc2822#section-3.4.1

Overrides:

validateSubType in class DBObject

Parameters:

field - The field

value - the value

Throws:

InvalidDataException - invalidate data

InvalidDataWarning

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

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

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class DBObject

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

useEmailBillToAddress

public static boolean useEmailBillToAddress(@Nonnull
                                            DataSource ds,
                                            @Nonnull
                                            DBEmailSend dBEmailSend)

Check if the DBEmailRecipient.email should be set to Contact.emailBillTo

Parameters:

ds -

dBEmailSend -

Returns: