com.adobe.idp.taskmanager.dsc.client.task
Class EmailNotifications

java.lang.Object
  com.adobe.idp.taskmanager.dsc.client.task.EmailNotifications

All Implemented Interfaces:

java.io.Serializable

public class EmailNotifications
extends java.lang.Object
implements java.io.Serializable

Object that determines and sets email notification properties for a task.

Email notifications can be sent to users when they are assigned a task, and when reminders and deadlines occur. Email notification settings are configured globally by using the Process Management ES2 tools in LiveCycle Administration Console. However, the EmailNotifications object lets you write applications that override those settings for a task.

See Also:

Serialized Form

Constructor Summary

EmailNotifications()

Method Summary

java.lang.String	getCc() Determines the Cc value for email notification.
java.lang.String	getEncoding() Determines the encoding for email notification.
java.lang.String	getFrom() Determines the From value for email notification.
java.lang.String	getMessage() Determines the message for email notification.
java.lang.String	getName() Determines the recipient name for email notification.
long	getNotificationType() Determines the notification type for the email notification.
java.lang.String	getSubject() Determines the Subject value for email notification.
boolean	isAttachForm() Determines whether to attach the task form in the message for email notification.
boolean	isHtmlFormat() Determines whether the message format for email notification is HTML.
boolean	isSendEmail() Determines whether the task sends email notifications to users.
void	setAttachForm(boolean attachForm) Sets whether to attach the task form in the message for email notification.
void	setCc(java.lang.String cc) Sets the Cc value for email notification.
void	setEncoding(java.lang.String encoding) Sets the encoding for email notification.
void	setFrom(java.lang.String from) Sets the From value for email notification.
void	setHtmlFormat(boolean htmlFormat) Sets the message format for email notification to HTML.
void	setMessage(java.lang.String message) Sets the message for email notification.
void	setName(java.lang.String name) Sets the recipient name for email notification.
void	setNotificationType(long notificationType) Sets the notification type for the email notification.
void	setSendEmail(boolean isDoNotSendEmail) Specifies whether to send the email notification.
void	setSubject(java.lang.String subject) Sets the Subject value for email notification.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailNotifications

public EmailNotifications()

Method Detail

isSendEmail

public boolean isSendEmail()

Determines whether the task sends email notifications to users.

setSendEmail

public void setSendEmail(boolean isDoNotSendEmail)

Specifies whether to send the email notification.

Parameters:

isDoNotSendEmail - A value of true enables the email notification.

getNotificationType

public long getNotificationType()

Determines the notification type for the email notification.

See Also:

TaskNotificationType

setNotificationType

public void setNotificationType(long notificationType)

Sets the notification type for the email notification.

See Also:

TaskNotificationType

getSubject

public java.lang.String getSubject()

Determines the Subject value for email notification.

setSubject

public void setSubject(java.lang.String subject)

Sets the Subject value for email notification.

getCc

public java.lang.String getCc()

Determines the Cc value for email notification.

setCc

public void setCc(java.lang.String cc)

Sets the Cc value for email notification.

getFrom

public java.lang.String getFrom()

Determines the From value for email notification.

setFrom

public void setFrom(java.lang.String from)

Sets the From value for email notification.

getMessage

public java.lang.String getMessage()

Determines the message for email notification.

setMessage

public void setMessage(java.lang.String message)

Sets the message for email notification. See LiveCycle Workbench Help for guidance on including XPath, process management variables, and other special values in the email notification message body.

getEncoding

public java.lang.String getEncoding()

Determines the encoding for email notification.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding for email notification.

By default, encoding is UTF-8.

isAttachForm

public boolean isAttachForm()

Determines whether to attach the task form in the message for email notification.

setAttachForm

public void setAttachForm(boolean attachForm)

Sets whether to attach the task form in the message for email notification.

This option is not available for deadlines.

isHtmlFormat

public boolean isHtmlFormat()

Determines whether the message format for email notification is HTML.

Returns:

true indicates the message format is HTML.

setHtmlFormat

public void setHtmlFormat(boolean htmlFormat)

Sets the message format for email notification to HTML.

getName

public java.lang.String getName()

Determines the recipient name for email notification.

setName

public void setName(java.lang.String name)

Sets the recipient name for email notification.