Package de.aristaflow.adept2.model.common.plugindata

Interface MailNotificationData

public interface MailNotificationData

Plug-in data for the mail notification escalation measure.

Author:

Kevin Goeser

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MailNotificationData.Addressees	Determines how the addressees are resolved for an item.
static class	MailNotificationData.MailField	Fields which can be replaced by

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID	My plug-in ID.

Method Summary

Modifier and Type	Method	Description
MailNotificationData.Addressees	getAddressees()	Returns how the addresses of the recipients are determined, cf.
String[]	getMailAddresses()
String	getMailBody()	The template string for the mail body.
String	getMailSubject()	The template string for the mail subject.
void	setAddressees(MailNotificationData.Addressees addressees)	Setter for getAddressees().
void	setMailAddresses(String[] addresses)	Setter for getMailAddresses()
void	setMailBody(String body)	Setter for getMailBody().
void	setMailSubject(String subject)	Setter for getMailSubject().

Field Detail

ID

static final String ID

My plug-in ID.

See Also:

Constant Field Values

Method Detail

getMailAddresses

String[] getMailAddresses()

Returns:

A list of mail addresses, only relevant if getAddressees() doesn't return MailNotificationData.Addressees.AssignmentMembers, MailNotificationData.Addressees.AssignmentSupervisorMembers or MailNotificationData.Addressees.AssignmentMembersAndSupervisors

setMailAddresses

void setMailAddresses(String[] addresses)

Setter for getMailAddresses()

Parameters:

addresses -

getMailBody

String getMailBody()
            throws UnresolvedParameterReferenceException

The template string for the mail body. The template may contain all variables declared by the enum MailNotificationData.MailField.

Returns:

The template for the mail body.

Throws:

UnresolvedParameterReferenceException

setMailBody

void setMailBody(String body)

Setter for getMailBody().

Parameters:

body -

getMailSubject

String getMailSubject()
               throws UnresolvedParameterReferenceException

The template string for the mail subject. The template may contain all variables declared by the enum MailNotificationData.MailField.

Returns:

The template for the mail body.

Throws:

UnresolvedParameterReferenceException

setMailSubject

void setMailSubject(String subject)

Setter for getMailSubject().

Parameters:

subject -

getAddressees

MailNotificationData.Addressees getAddressees()

Returns how the addresses of the recipients are determined, cf. MailNotificationData.Addressees for more information.

Returns:

Where to get the mail addresses from.

setAddressees

void setAddressees(MailNotificationData.Addressees addressees)

Setter for getAddressees().

Parameters:

addressees -