com.aspc.DBObj.Email

Class DBEmailFolder

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailFolder

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEmailFolder
extends DBObject

Identifies a folder on a mail server containing a users emails.

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

Since:

April 14, 2003

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 GlobalId	DBCLASS_GID Identifies a folder on a mail server containing a users emails.
static java.lang.String	DBCLASS_NAME Identifies a folder on a mail server containing a users emails.
static java.lang.String	UNSUBSCRIBE

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEmailFolder	create(MutableDataSource mds) Make a new instance of this class.
protected DBEmail	createEmail(java.lang.String messageId, MutableDataSource mds, Message message)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBEmailAccount	findAccount(java.lang.String... args) The account.
static DBEmailFolder	findKey(DataSource ds, int key) Find the target for this class by the primary key
Person	findNotifyContactWhenIgnored(java.lang.String... args) Notify Contact When Ignored.
DBEmailAccount	getAccount(java.lang.String... args)
java.lang.String	getFolder(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getIgnoredFolder(java.lang.String... args)
java.util.Date	getLastScanned(java.lang.String... args)
protected MutableDataSource	getNewMDS()
Person	getNotifyContactWhenIgnored(java.lang.String... args)
java.lang.String	getProcessedFolder(java.lang.String... args)
java.lang.String	getRuleSenderPattern(java.lang.String... args)
java.util.Date	getRuleSentAfterTS(java.lang.String... args)
java.lang.String	getWorkingFolder(java.lang.String... args)
boolean	isFiltered(java.lang.String... args)
boolean	isIncludeAlerts(java.lang.String... args)
boolean	isLeaveMsgOnServer(java.lang.String... args)
protected boolean	isMessageErrorNotification(Message message)
protected boolean	isReceivedMessageInteresting(Message message)
boolean	isReScan(java.lang.String... args)
boolean	isRuleRecipientExists(java.lang.String... args)
boolean	isRuleSenderExists(java.lang.String... args)
boolean	isScanStEmails(java.lang.String... args)
protected boolean	isUnsubsribe(Message message) Determines if the message is an instruction to unsubscribe
static DBQuery<DBEmailFolder>	makeQuery(DataSource ds) Make a new QUERY for this class.
void	process()
void	processMessage(Folder folder, Message message, MutableDataSource mds, boolean rescan)
protected void	reAssociateEmail(MutableDataSource mds, DBEmail emailRO)
protected int	scan(Folder folder)
DBEmailFolder	setAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
DBEmailFolder	setFiltered(boolean value, java.lang.String... args)
DBEmailFolder	setFolder(java.lang.String value, java.lang.String... args)
DBEmailFolder	setID(int value, java.lang.String... args)
DBEmailFolder	setIgnoredFolder(java.lang.String value, java.lang.String... args)
DBEmailFolder	setIncludeAlerts(boolean value, java.lang.String... args)
DBEmailFolder	setLastScanned(java.util.Date value, java.lang.String... args)
DBEmailFolder	setLeaveMsgOnServer(boolean value, java.lang.String... args)
DBEmailFolder	setNotifyContactWhenIgnored(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBEmailFolder	setProcessedFolder(java.lang.String value, java.lang.String... args)
DBEmailFolder	setReScan(boolean value, java.lang.String... args)
DBEmailFolder	setRuleRecipientExists(boolean value, java.lang.String... args)
DBEmailFolder	setRuleSenderExists(boolean value, java.lang.String... args)
DBEmailFolder	setRuleSenderPattern(java.lang.String value, java.lang.String... args)
DBEmailFolder	setRuleSentAfterTS(java.util.Date value, java.lang.String... args)
DBEmailFolder	setScanStEmails(boolean value, java.lang.String... args)
DBEmailFolder	setUseListener(boolean value, java.lang.String... args)
DBEmailFolder	setWorkingFolder(java.lang.String value, java.lang.String... args)
protected void	updateEmail(MutableDataSource mds, DBEmail emailRO, Message message)
protected void	updateEmailErrors(MutableDataSource mds, Message message)
protected void	updateUnsubscribe(MutableDataSource mds, DBEmail emailRO) Unsubscribes the sender of an email from any group emails
boolean	useListener(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, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, 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, 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

Identifies a folder on a mail server containing a users emails.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Identifies a folder on a mail server containing a users emails.

UNSUBSCRIBE

public static final java.lang.String UNSUBSCRIBE

See Also:

Constant Field Values

Constructor Detail

DBEmailFolder

public DBEmailFolder(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 DBEmailFolder 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.

--> DBEmailAccount (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setAccount

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

Throws:

java.lang.Exception

isFiltered

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

setFiltered

@Nonnull
public DBEmailFolder setFiltered(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getFolder

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

setFolder

@Nonnull
public DBEmailFolder setFolder(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getIgnoredFolder

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

setIgnoredFolder

@Nonnull
public DBEmailFolder setIgnoredFolder(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

isIncludeAlerts

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

setIncludeAlerts

@Nonnull
public DBEmailFolder setIncludeAlerts(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getLastScanned

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

setLastScanned

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

Throws:

java.lang.Exception

isLeaveMsgOnServer

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

setLeaveMsgOnServer

@Nonnull
public DBEmailFolder setLeaveMsgOnServer(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getNotifyContactWhenIgnored

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

findNotifyContactWhenIgnored

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

Notify Contact When Ignored.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setNotifyContactWhenIgnored

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

Throws:

java.lang.Exception

getProcessedFolder

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

setProcessedFolder

@Nonnull
public DBEmailFolder setProcessedFolder(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

isReScan

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

setReScan

@Nonnull
public DBEmailFolder setReScan(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isRuleRecipientExists

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

setRuleRecipientExists

@Nonnull
public DBEmailFolder setRuleRecipientExists(boolean value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

isRuleSenderExists

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

setRuleSenderExists

@Nonnull
public DBEmailFolder setRuleSenderExists(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getRuleSenderPattern

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

setRuleSenderPattern

@Nonnull
public DBEmailFolder setRuleSenderPattern(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getRuleSentAfterTS

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

setRuleSentAfterTS

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

Throws:

java.lang.Exception

isScanStEmails

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

setScanStEmails

@Nonnull
public DBEmailFolder setScanStEmails(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

useListener

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

setUseListener

@Nonnull
public DBEmailFolder setUseListener(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getWorkingFolder

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

setWorkingFolder

@Nonnull
public DBEmailFolder setWorkingFolder(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
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

process

public void process()
             throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

scan

protected int scan(@Nonnull
                   Folder folder)
            throws java.lang.Exception

Parameters:

folder -

Returns:

expunged count.

Throws:

java.lang.Exception - a serious problem

processMessage

public void processMessage(@Nonnull
                           Folder folder,
                           @Nonnull
                           Message message,
                           @Nonnull
                           MutableDataSource mds,
                           boolean rescan)
                    throws java.lang.Exception

Throws:

java.lang.Exception

isReceivedMessageInteresting

@CheckReturnValue
protected boolean isReceivedMessageInteresting(@Nonnull
                                                                 Message message)
                                                          throws java.lang.Exception

Parameters:

message - the message

Returns:

the value

Throws:

java.lang.Exception - a serious problem

isMessageErrorNotification

@CheckReturnValue
protected boolean isMessageErrorNotification(@Nonnull
                                                               Message message)
                                                        throws java.lang.Exception

Parameters:

message - the message

Returns:

the value

Throws:

java.lang.Exception - a serious problem

updateEmailErrors

protected void updateEmailErrors(@Nonnull
                                 MutableDataSource mds,
                                 @Nonnull
                                 Message message)

Parameters:

mds - the mutable data source

message - the message

isUnsubsribe

@CheckReturnValue
protected boolean isUnsubsribe(@Nonnull
                                                 Message message)
                                          throws java.lang.Exception

Determines if the message is an instruction to unsubscribe

Parameters:

message - the message

Returns:

the value

Throws:

java.lang.Exception - a serious problem

updateUnsubscribe

protected void updateUnsubscribe(@Nonnull
                                 MutableDataSource mds,
                                 @Nullable
                                 DBEmail emailRO)
                          throws java.lang.Exception

Unsubscribes the sender of an email from any group emails

Parameters:

mds - the mutable data source

emailRO - the email

Throws:

java.lang.Exception - a serious problem

updateEmail

protected void updateEmail(@Nonnull
                           MutableDataSource mds,
                           @Nonnull
                           DBEmail emailRO,
                           @Nonnull
                           Message message)
                    throws java.lang.Exception

Parameters:

mds - the mutable data source

emailRO -

message - the message

Throws:

java.lang.Exception - a serious problem

reAssociateEmail

protected void reAssociateEmail(@Nonnull
                                MutableDataSource mds,
                                @Nonnull
                                DBEmail emailRO)
                         throws java.lang.Exception

Parameters:

mds - the mutable data source

emailRO -

Throws:

java.lang.Exception - a serious problem

getNewMDS

@CheckReturnValue
 @Nonnull
protected MutableDataSource getNewMDS()
                                                           throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

createEmail

@CheckReturnValue
 @Nonnull
protected DBEmail createEmail(@Nonnull
                                                          java.lang.String messageId,
                                                          @Nonnull
                                                          MutableDataSource mds,
                                                          @Nonnull
                                                          Message message)
                                                   throws java.lang.Exception

Parameters:

messageId - the message id

mds - the mutable data source

message - the message

Returns:

the value

Throws:

java.lang.Exception - a serious problem