|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.notification.Digest
Models the envelope information associated with a digest. When a digest is processed, all notifications associated with it are grouped for delivery as a single unit to each receiver. The outbound email generated for the receivers has a common subject, header, separator between the individual messages, and signature.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
CANCELLED
|
static int |
DAILY
|
static String |
DIGEST_ID
|
static String |
EXPAND_GROUP
|
static String |
EXPUNGE_MSG_P
|
static String |
EXPUNGE_P
|
static String |
FAILED
|
static String |
FAILED_PARTIAL
|
static String |
FREQUENCY
|
static String |
FULFILL_DATE
|
static String |
GET_DIGEST_QUEUED_NOTIFICATIONS
|
static String |
GET_SIMPLE_QUEUED_NOTIFICATIONS
|
static String |
HEADER
|
static int |
HOURLY
|
static String |
MAX_RETRIES
|
static String |
MESSAGE_ID
|
static String |
NEXT_RUN
|
static String |
PARTY_FROM
|
static String |
PARTY_TO
|
static String |
PARTY_TO_ADDR
|
static String |
PENDING
|
static String |
QUEUED
|
static String |
REQUEST_DATE
|
static String |
REQUEST_ID
|
static String |
RETRY_COUNT
|
static String |
SENT
|
static String |
SEPARATOR
|
static String |
SIGNATURE
|
static String |
STATUS
|
static String |
SUBJECT
|
static String |
SUCCESS
|
static int |
WEEKLY
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE, versionId |
Constructor Summary | |
Digest()
Default constructor. |
|
Digest(BigDecimal id)
Retrieve a digest with the given id; |
|
Digest(DataObject dataObj)
Creates a Digest from a DataObject |
|
Digest(OID oid)
Retrieves an existing digest from the database. |
|
Digest(Party from,
String subject,
String header,
String signature)
Creates a digest with the default processing frequency and separator. |
Method Summary | |
protected void |
beforeSave()
Saves the Digest to the database so it can be used for sending notifications. |
Integer |
getFrequency()
Gets the current processing frequency (in minutes) for this digest. |
Party |
getFrom()
Gets the sender of the digest. |
String |
getFromEmail()
Gets the email address of the digest sender as a string. |
String |
getHeader()
Gets the common header for the digest. |
Date |
getNextRun()
Get the date when this digest will next be processed. |
String |
getSeparator()
Gets the current separator for elements of the digest. |
String |
getSignature()
Gets the signature used for this digest. |
String |
getSubject()
Gets the common subject for the digest. |
void |
setFrequency(int frequency)
Sets the processing frequency (in minutes) for this digest. |
void |
setFrom(Party from)
Sets the common sender for the digest. |
void |
setHeader(String header)
Set the common header for the digest. |
void |
setSeparator(char s,
int n)
Sets the separator by specifing a single character and a repeat count. |
void |
setSeparator(String separator)
Sets the separator by specifying its value as a String. |
void |
setSignature(String signature)
Sets the signature used for this digest. |
void |
setSubject(String subject)
Sets the common subject for the digest. |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getBaseDataObjectType, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String BASE_DATA_OBJECT_TYPE
public static final int HOURLY
public static final int DAILY
public static final int WEEKLY
public static final String DIGEST_ID
public static final String REQUEST_ID
public static final String MESSAGE_ID
public static final String PARTY_TO
public static final String PARTY_TO_ADDR
public static final String PARTY_FROM
public static final String RETRY_COUNT
public static final String SUCCESS
public static final String EXPAND_GROUP
public static final String REQUEST_DATE
public static final String FULFILL_DATE
public static final String STATUS
public static final String MAX_RETRIES
public static final String EXPUNGE_P
public static final String EXPUNGE_MSG_P
public static final String HEADER
public static final String SIGNATURE
public static final String SUBJECT
public static final String SEPARATOR
public static final String FREQUENCY
public static final String NEXT_RUN
public static final String PENDING
public static final String QUEUED
public static final String SENT
public static final String FAILED
public static final String FAILED_PARTIAL
public static final String CANCELLED
public static final String GET_SIMPLE_QUEUED_NOTIFICATIONS
public static final String GET_DIGEST_QUEUED_NOTIFICATIONS
Constructor Detail |
public Digest()
public Digest(Party from, String subject, String header, String signature)
from
- the party responsible for sending the digestsubject
- the common subject for digest notificationsheader
- the common headersignature
- the common signaturepublic Digest(OID oid) throws DataObjectNotFoundException
oid
- the OID of the digestpublic Digest(DataObject dataObj)
dataObj
- the DataObject the Digest will wrappublic Digest(BigDecimal id) throws DataObjectNotFoundException
id
- the id for the DataObject to retrieve.Method Detail |
public Party getFrom() throws DataObjectNotFoundException
DataObjectNotFoundException
public String getFromEmail()
public void setFrom(Party from)
from
- the common senderpublic String getSubject()
public void setSubject(String subject)
subject
- the common subjectpublic String getHeader()
public void setHeader(String header)
header
- the common headerpublic String getSeparator()
public void setSeparator(String separator)
separator
- the value of the separatorpublic void setSeparator(char s, int n)
s
- the separator charactern
- the repeat countpublic String getSignature()
public void setSignature(String signature)
signature
- the signature for the digestpublic Integer getFrequency()
public void setFrequency(int frequency)
frequency
- the processing frequency in minutespublic Date getNextRun()
protected void beforeSave()
beforeSave
in class ACSObject
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |