planetj.dataengine.email
Class EmailRowCollection

java.lang.Object
  |
  +--planetj.database.RowCollection
        |
        +--planetj.dataengine.email.EmailRowCollection

All Implemented Interfaces:

Cloneable, Collection, IBatchProcessObject, IDistributedExecutableObject, IEmailObject, IFDFObject, INavigationObject, IXMLObject, List, Serializable

Direct Known Subclasses:

HTMLEmailRowCollection

public abstract class EmailRowCollection

extends RowCollection

implements IEmailObject

This class servers as a convience class for a RowCollection that contains email functionality.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.RowCollection

RowCollection.LinkedRowCollection

Field Summary

Fields inherited from class planetj.database.RowCollection

className, FIRST_ROW, LAST_ROW

Fields inherited from interface planetj.dataengine.email.IEmailObject

CONFIG_KEY_POP3_SERVER, CONFIG_KEY_SMTP_SERVER, CONFIG_KEY_SMTP_USER_EMAIL, CONFIG_KEY_SMTP_USER_ID, CONFIG_KEY_SMTP_USER_PASSWORD

Constructor Summary

EmailRowCollection()
EmailRowCollection constructor comment.

EmailRowCollection(Table table)
EmailRowCollection constructor comment.

EmailRowCollection(Table table, List fieldNames)
EmailRowCollection constructor comment.

Method Summary

String	getEmailSubject(ExecutingContext ec) Get the email's subject.
CMMailer	getMailer(ExecutingContext ec) Get this Row's mailer.
String	getPOP3Server(ExecutingContext ec) Get this Row's SMTP server.
String	getSMTPServer(ExecutingContext ec) Get this Row's SMTP server.
String	getSMTPUserEmail(ExecutingContext ec) Get this Row's SMTP user email.
String	getSMTPUserId(ExecutingContext ec) Get this Row's SMTP server.
String	getSMTPUserPassword(ExecutingContext ec) Get this Row's SMTP user password.

Methods inherited from class planetj.database.RowCollection

add, add, addAll, addAll, addFDRows, addRow, addRow, addRowEventListener, addRows, addTable, batchProcess, clear, clearRows, clearTables, clone, cloneRowCollection, contains, contains, containsAll, containsRowWithFieldsEqualTo, copyToConnection, copyToConnection, copyToConnection, createFieldDescriptor, createRowCollection, delete, delete, delete, delete, doesFieldDescriptorExist, executeDistributedAction, filter, filter, filter, firstRow, get, getAttribute, getColumnCount, getColumnValues, getColumnValues, getColumnValuesByUsageId, getCompleteRowCollection, getCompleteRowCollection, getConfigProperty, getConnectedChildren, getContainedClass, getDistributedRequestorURL, getEstimatedSize, getExternalName, getExternalNames, getExternalNames, getFDFData, getFieldCount, getFieldDescriptor, getFieldDescriptorCollection, getFieldDescriptorCollection, getFieldDescriptors, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldNames, getFieldNameSets, getFields, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getGraphableFieldNames, getJoinFieldNames, getLastUpdated, getLibraryName, getMetaDataSystemAlias, getNavigationKey, getNavigationListKey, getNextRowCollection, getNextRowCollection, getPreviousRowCollection, getPreviousRowCollection, getPropertyGroup, getPropertyGroups, getPropertyGroups, getResultSet, getRetrievedRowCount, getRow, getRowCount, getRows, getSortedColumnNames, getSortedColumnNamesAscending, getSQL, getSQLContext, getSum, getSystemAlias, getTable, getTableName, getTables, getTimestamp, getTitle, getValidationExceptions, getValueAsDouble, getValueAsDouble, getXMLData, getXMLData, getXMLHeaderData, getXMLHeaderData, handleDistributed, hasConnectedChildren, hasNextRowCollection, hasPreviousRowCollection, indexOf, indexOf, insert, insert, insert, insert, insertBatch, isARow, isARowCollection, isCloneNeeded, isCurrent, isEmpty, isFromCache, isFromGroupBy, isFromJoin, isGraphable, isHasColumnNames, isHasRowEventListners, isLocked, isOkToReturnMeFromCache, isRowCollectionContainEditableRow, isValidateRequired, iterator, lastIndexOf, listIterator, listIterator, newRow, newRow, prepareForDisplay, prepareForResults, prepareForReturnFromCache, prepareFromFieldNames, reconcile, reconcile, refresh, refreshIfNeeded, remove, remove, removeAll, removeAllRows, removeAttribute, removeNavigationKey, removeRow, removeRow, removeRow, removeRowBasedOnKeyValues, removeRowEventListener, removeTable, replaceRow, retainAll, rollbackChanges, rowAltered, set, setAttribute, setColumnValues, setContainedClass, setDistributed, setDistributedRequestorURL, setDistributedSourceURL, setDistributedTargetURL, setLastUpdated, setNavigationKey, setPropertyGroups, setResultSet, setRow, setSortedColumnNames, setSql, setSystemAlias, setTable, setTables, setTables, size, sort, sortInternal, subList, toArray, toArray, toCSV, toCSV, toDOC, toDOC, toFDF, toPDF, toString, toUpperCase, toXML, update, update, update, update, validate, validate, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.email.IEmailObject

getEmailBody, getEmailRecipients

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

EmailRowCollection

public EmailRowCollection()

EmailRowCollection constructor comment.

EmailRowCollection

public EmailRowCollection(Table table)
                   throws CMException

EmailRowCollection constructor comment.

Parameters:

table - planetj.database.Table

Throws:

CMException - The exception description.

EmailRowCollection

public EmailRowCollection(Table table,
                          List fieldNames)
                   throws CMException

EmailRowCollection constructor comment.

Parameters:

table - planetj.database.Table

fieldNames - java.util.List

Throws:

CMException - The exception description.

Method Detail

getEmailSubject

public String getEmailSubject(ExecutingContext ec)

Get the email's subject.

Specified by:

getEmailSubject in interface IEmailObject

getMailer

public CMMailer getMailer(ExecutingContext ec)

Get this Row's mailer.

Specified by:

getMailer in interface IEmailObject

getPOP3Server

public String getPOP3Server(ExecutingContext ec)

Get this Row's SMTP server.

Specified by:

getPOP3Server in interface IEmailObject

getSMTPServer

public String getSMTPServer(ExecutingContext ec)

Get this Row's SMTP server.

Specified by:

getSMTPServer in interface IEmailObject

getSMTPUserEmail

public String getSMTPUserEmail(ExecutingContext ec)

Get this Row's SMTP user email.

Specified by:

getSMTPUserEmail in interface IEmailObject

getSMTPUserId

public String getSMTPUserId(ExecutingContext ec)

Get this Row's SMTP server.

Specified by:

getSMTPUserId in interface IEmailObject

getSMTPUserPassword

public String getSMTPUserPassword(ExecutingContext ec)

Get this Row's SMTP user password.

Specified by:

getSMTPUserPassword in interface IEmailObject