|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EmailRecipientCalculator
Defines a pluggable implementation of a calculator that can produce the email addresses of actors that are to receive email notifications for a given TaskEvent. This interface is really only intended to provide a simple facility for augmenting the To: list for emails that are already getting sent from the default email subsystem in Worklist. If you need to control the subject, body, or other attributes of emails being sent, you should define your own custom event listener from which you can send custom emails.
Implementations of this interface MUST provide a public default (no arg) constructor. Implementations must make no assumptions about the lifecycle of their instances nor their relationship to other instances. Lifecycle is controlled entirely via the initialize() and destroy() methods.
Method Summary | |
---|---|
void |
destroy()
Destroy this instance and release any resources obtained in initialize or during calls to getEmailRecipientsForEvent(). |
String[] |
getEmailRecipientsForEvent(TaskEvent event,
Set<String> currentRecipients)
Calculate the email addresses for any actors that should receive email notification for the given event. |
void |
initialize()
Initialize any resources needed to start calculating email addresses in getEmailRecipientsForEvent(). |
void |
setProperties(Property[] properties)
Set any properties configured for this EmailRecipientCalculator in the custom module that deployed it. |
Method Detail |
---|
void setProperties(Property[] properties)
properties
- void initialize() throws ManagementException
ManagementException
void destroy() throws ManagementException
ManagementException
String[] getEmailRecipientsForEvent(TaskEvent event, Set<String> currentRecipients) throws ManagementException
event
- The event for which email notifications are to be sent.currentRecipients
- This is a set of email addresses to which
the email for this event will already be sent. This set is a
copy of the set that will be used to populate the To: list on the
email, so adding/removing items in this set has no effect.
ManagementException
- If any error occurs calculating recipients.
This error will be logged to the server log, but otherwise
will not alter the handling of this event.TaskURLCalculator
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |