com.ibm.itim.dataservices.model.domain
Class NotificationTemplate

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.domain.NotificationTemplate

All Implemented Interfaces:

com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class NotificationTemplate
extends DirectoryEntry
implements java.io.Serializable

Represents a template for a notification message.

See Also:

Serialized Form

Field Summary

static int	MAIL_TEMPLATE
static int	MANUAL_SERVICE_MODE
static int	PROVISIONINGRECERT_WORKORDER
static int	RECERT_APPROVAL
static int	RECERT_WORKORDER
static int	SODRECERT_WORKORDER
static int	UNDEFINED_TYPE Type of template must one of the following values: RECERT_APPROVAL - for the approval node of recertification RECERT_WORKORDER - for the workorder node of recertification MAIL_TEMPLATE - for the mail template USERRECERT_APPROVAL - for the approval node of user recertification USERRECERT_WORKORDER - for the workorder node of user recertification SODRECERT_WORKORDER - for the workorder node of sod recertification PROVISIONINGRECERT_WORKORDER - for the workorder node of provisioning recertification MANUAL_SERVICE_MODE - for the manual and manual connected service default template
static int	USERRECERT_APPROVAL
static int	USERRECERT_WORKORDER

Constructor Summary

NotificationTemplate()
Default constructor.

NotificationTemplate(java.lang.String name, boolean enable, java.lang.String subject, java.lang.String text, java.lang.String html)
Constructs with full set of parameters.

NotificationTemplate(java.lang.String name, java.lang.String subject, java.lang.String text, java.lang.String html)
Constructs with full set of parameters.

Method Summary

void	disableReadOnly() Disable the readonly property for the notification template.
void	enableReadOnly() Enable the readonly property for the notification template.
java.lang.String	getHTMLBody() Returns the template for the HTML body of the notification.
java.lang.String	getName() Returns the name of the notification template.
java.lang.String	getSubject() Returns the template for the subject of the notification.
java.lang.String	getTextBody() Returns the template for the text body of the notification.
int	getType() Returns type of the of the notification template.
boolean	isEnabled() Determines if the the notification template is enabled.
boolean	isReadOnly() Determine if the content of the template can be modified or altered.
void	setHTMLBody(java.lang.String html) Changes the template for the HTML body of the notification.
void	setIsEnabled(boolean enable) Enable or Disable the notification template.
void	setName(java.lang.String name) Sets the name of the notification template.
void	setSubject(java.lang.String subject) Changes the template for the subject of the notification.
void	setTextBody(java.lang.String text) Changes the template for the text body of the notification.
void	setType(int templateType) Changes the type of notification template.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

addAttribute, addAttributeValues, clearChange, clearChanges, getAttribute, getAttributes, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, removeAttribute, removeAttribute, setAttribute, setAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED_TYPE

public static final int UNDEFINED_TYPE

Type of template must one of the following values:

• RECERT_APPROVAL - for the approval node of recertification
• RECERT_WORKORDER - for the workorder node of recertification
• MAIL_TEMPLATE - for the mail template
• USERRECERT_APPROVAL - for the approval node of user recertification
• USERRECERT_WORKORDER - for the workorder node of user recertification
• SODRECERT_WORKORDER - for the workorder node of sod recertification
• PROVISIONINGRECERT_WORKORDER - for the workorder node of provisioning recertification
• MANUAL_SERVICE_MODE - for the manual and manual connected service default template

See Also:

Constant Field Values

RECERT_APPROVAL

public static final int RECERT_APPROVAL

See Also:

Constant Field Values

RECERT_WORKORDER

public static final int RECERT_WORKORDER

See Also:

Constant Field Values

MAIL_TEMPLATE

public static final int MAIL_TEMPLATE

See Also:

Constant Field Values

USERRECERT_APPROVAL

public static final int USERRECERT_APPROVAL

See Also:

Constant Field Values

USERRECERT_WORKORDER

public static final int USERRECERT_WORKORDER

See Also:

Constant Field Values

SODRECERT_WORKORDER

public static final int SODRECERT_WORKORDER

See Also:

Constant Field Values

PROVISIONINGRECERT_WORKORDER

public static final int PROVISIONINGRECERT_WORKORDER

See Also:

Constant Field Values

MANUAL_SERVICE_MODE

public static final int MANUAL_SERVICE_MODE

See Also:

Constant Field Values

Constructor Detail

NotificationTemplate

public NotificationTemplate()

Default constructor.

NotificationTemplate

public NotificationTemplate(java.lang.String name,
                            java.lang.String subject,
                            java.lang.String text,
                            java.lang.String html)

Constructs with full set of parameters.

Parameters:

subject - Template for the subject of the notification.

text - Template for the text body of the notification.

html - Template for the HTML body of the notification.

NotificationTemplate

public NotificationTemplate(java.lang.String name,
                            boolean enable,
                            java.lang.String subject,
                            java.lang.String text,
                            java.lang.String html)

Constructs with full set of parameters.

Parameters:

subject - Template for the subject of the notification.

text - Template for the text body of the notification.

html - Template for the HTML body of the notification.

Method Detail

getName

public java.lang.String getName()

Returns the name of the notification template.

Returns:

name of the template.

setName

public void setName(java.lang.String name)

Sets the name of the notification template.

Parameters:

name - of the template.

isEnabled

public boolean isEnabled()

Determines if the the notification template is enabled.

Returns:

Subject template.

setIsEnabled

public void setIsEnabled(boolean enable)

Enable or Disable the notification template.

Parameters:

enable - boolean value to enable or disable the template.

getSubject

public java.lang.String getSubject()

Returns the template for the subject of the notification.

Returns:

Subject template.

setSubject

public void setSubject(java.lang.String subject)

Changes the template for the subject of the notification.

Parameters:

subject - Template for the subject of the notification.

getTextBody

public java.lang.String getTextBody()

Returns the template for the text body of the notification.

Returns:

Text body template.

setTextBody

public void setTextBody(java.lang.String text)

Changes the template for the text body of the notification.

Parameters:

text - Template for the text body of the notification.

getHTMLBody

public java.lang.String getHTMLBody()

Returns the template for the HTML body of the notification.

Returns:

HTML body template.

setHTMLBody

public void setHTMLBody(java.lang.String html)

Changes the template for the HTML body of the notification.

Parameters:

html - Template for the HTML body of the notification.

getType

public int getType()

Returns type of the of the notification template.

Returns:

If the type is defined for the template, return it. The following type of tempaltes are returned:

• NotificationTemplate.RECERT_APPROVAL - recertification approval template
• NotificationTemplate.RECERT_WORKORDER - recertification work order template
• NotificationTemplate.MAIL_TEMPLATE - mail template
• NotificationTemplate.UNDEFINED_TYPE - type is not defined for this template

setType

public void setType(int templateType)

Changes the type of notification template.

Parameters:

templateType - type of the notification template. It must be one of the following values:

• NotificationTemplate.RECERT_APPROVAL - recertification approval template
• NotificationTemplate.RECERT_WORKORDER - recertification work order template
• NotificationTemplate.MAIL_TEMPLATE - mail template

enableReadOnly

public void enableReadOnly()

Enable the readonly property for the notification template. If it's readonly, the user shouldn't be allowed to modify the template. Else, the template is modifiable.

disableReadOnly

public void disableReadOnly()

Disable the readonly property for the notification template. If it's readonly, the user shouldn't be allowed to modify the template. Else, the template is modifiable.

isReadOnly

public boolean isReadOnly()

Determine if the content of the template can be modified or altered. Default: the template is modifiable.

toString

public java.lang.String toString()

Description copied from class: DirectoryEntry

Returns a string representation of the object.

Overrides:

toString in class DirectoryEntry

Returns:

String representation of the object