com.bmc.arsys.api
Class NotifyAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.NotifyAction

All Implemented Interfaces:

FilterAction, Serializable, Cloneable

public class NotifyAction
extends Action
implements FilterAction, Cloneable, Serializable

The NotifyActionInfo class is used to to send a message to specified users or groups by email, Remedy Alert, or other mechanism for any transaction that meets the filter or escalation conditions.

See Also:

Serialized Form

Constructor Summary

NotifyAction()
constructor

NotifyAction(String user, String notifyText, int notifyPriority, int notifyMechanism, int notifyMechanismXRef, String subjectText, int fieldIdListType, List<Integer> fieldIdList, int notifyBehavior, int notifyPermission)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getBcc() Returns bcc.
String	getCc() Returns cc.
String	getContentTemplate() Returns context template.
List<Integer>	getFieldIdList() Returns list of fields whose values are included in the notification.
int	getFieldIdListType() Returns fieldIdListType that indicates whether to include all, none, selected, or changed field whose values are included in the message.
String	getFooterTemplate() Returns footer template.
String	getFrom() Returns the value of from.
String	getHeaderTemplate() returns header template.
String	getMailboxName() Returns mailbox name.
int	getNotifyBehavior() Returns list of fields whose values are included in the notification.
int	getNotifyMechanism() Returns the field ID where the notification mechanism is selected based on the getFieldIdListType() values.
int	getNotifyMechanismXRef() Returns users who are notified using the mechanism specified by an integer value of the given field.
int	getNotifyPermission() Returns list of fields whose values are included in the notification.
int	getNotifyPriority() Reserved for future use by Remedy.
String	getNotifyText() Returns text of the notification message.
String	getOrganization() Returns organization.
String	getReplyTo() Returns reply to.
int	getReserved1()
int	getReserved2()
int	getReserved3()
String	getSubjectText() Returns subject text for the notification.
String	getUser() Returns name of the users or groups to notify.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setBcc(String bcc) Sets bcc.
void	setCc(String cc) Sets cc.
void	setContentTemplate(String contentTemplate) Sets context template.
void	setFieldIdList(List<Integer> fieldIdList) Sets list of fields whose values are included in the notification.
void	setFieldIdListType(int fieldIdListType) Sets fieldIdListType that indicates whether to include all, none, selected, or changed field whose values are included in the message.
void	setFooterTemplate(String footerTemplate) Sets footer template.
void	setFrom(String from) Defines from.
void	setHeaderTemplate(String headerTemplate) sets header template.
void	setMailboxName(String mailboxName) Sets mail box name.
void	setNotifyBehavior(int notifyBehavior) Sets list of fields whose values are included in the notification.
void	setNotifyMechanism(int notifyMechanism) Sets the field ID where the notification mechanism is selected based on the setFieldIdListType(int) values.
void	setNotifyMechanismXRef(int notifyMechanismXRef) Defines users who are notified using the mechanism specified by an integer value of the given field.
void	setNotifyPermission(int notifyPermission) Sets list of fields whose values are included in the notification.
void	setNotifyPriority(int notifyPriority) Reserved for future use by Remedy.
void	setNotifyText(String notifyText) Defines text of the notification message.
void	setOrganization(String organization) Sets organization.
void	setReplyTo(String replyTo) Defines reply to.
void	setReserved1(int reserved1)
void	setReserved2(int reserved2)
void	setReserved3(int reserved3)
void	setSubjectText(String subjectText) Defines subject text for the notification.
void	setUser(String user) Defines name of the users or groups to notify.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.Action

equals, getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotifyAction

public NotifyAction()

constructor

NotifyAction

public NotifyAction(String user,
                    String notifyText,
                    int notifyPriority,
                    int notifyMechanism,
                    int notifyMechanismXRef,
                    String subjectText,
                    int fieldIdListType,
                    List<Integer> fieldIdList,
                    int notifyBehavior,
                    int notifyPermission)

Method Detail

getUser

public String getUser()

Returns name of the users or groups to notify. Each user or group should be separated by a new line.

setUser

public void setUser(String user)

Defines name of the users or groups to notify. Each user or group should be separated by a new line.

getNotifyText

public String getNotifyText()

Returns text of the notification message.

setNotifyText

public void setNotifyText(String notifyText)

Defines text of the notification message.

getNotifyPriority

public int getNotifyPriority()

Reserved for future use by Remedy.

setNotifyPriority

public void setNotifyPriority(int notifyPriority)

Reserved for future use by Remedy.

getNotifyMechanism

public int getNotifyMechanism()

Returns the field ID where the notification mechanism is selected based on the getFieldIdListType() values.

setNotifyMechanism

public void setNotifyMechanism(int notifyMechanism)

Sets the field ID where the notification mechanism is selected based on the setFieldIdListType(int) values.

getNotifyMechanismXRef

public int getNotifyMechanismXRef()

Returns users who are notified using the mechanism specified by an integer value of the given field.

setNotifyMechanismXRef

public void setNotifyMechanismXRef(int notifyMechanismXRef)

Defines users who are notified using the mechanism specified by an integer value of the given field. Users are notified based on the field value in the current request. The meanings of each numeric value are shown as the following constants (the first item in a selection field has a value of 0):

• AR_NOTIFY_NONE -- Do not notify.
• AR_NOTIFY_VIA_NOTIFIER -- Remedy Alert.
• AR_NOTIFY_VIA_EMAIL -- Email.
• AR_NOTIFY_VIA_DEFAULT -- User default.
• AR_NOTIFY_VIA_XREF -- Specified users are notified using the mechanism specified. If you choose this option, enter a numeric value between 4 and 98 to indicate the mechanism to use.

getSubjectText

public String getSubjectText()

Returns subject text for the notification.

setSubjectText

public void setSubjectText(String subjectText)

Defines subject text for the notification.

getFieldIdListType

public int getFieldIdListType()

Returns fieldIdListType that indicates whether to include all, none, selected, or changed field whose values are included in the message.

setFieldIdListType

public void setFieldIdListType(int fieldIdListType)

Sets fieldIdListType that indicates whether to include all, none, selected, or changed field whose values are included in the message. The possible values and the meaning for the field types are the following constants:

• AR_FILTER_FIELD_IDS_NONE -- None of the fields are included with the notification.
• AR_FILTER_FIELD_IDS_ALL -- All of the fields in the request are included with the notification.
• AR_FILTER_FIELD_IDS_LIST -- Selected fields from the fieldIdListType list are included with the notification.
• AR_FILTER_FIELD_IDS_CHANGED -- Only fields that have changed in the current transaction are included with the notification.

getFieldIdList

public List<Integer> getFieldIdList()

Returns list of fields whose values are included in the notification.

setFieldIdList

public void setFieldIdList(List<Integer> fieldIdList)

Sets list of fields whose values are included in the notification.

getNotifyBehavior

public int getNotifyBehavior()

Returns list of fields whose values are included in the notification.

setNotifyBehavior

public void setNotifyBehavior(int notifyBehavior)

Sets list of fields whose values are included in the notification.

getNotifyPermission

public int getNotifyPermission()

Returns list of fields whose values are included in the notification.

setNotifyPermission

public void setNotifyPermission(int notifyPermission)

Sets list of fields whose values are included in the notification.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Action

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Action

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Action

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Action

getFrom

public String getFrom()

Returns the value of from.

setFrom

public void setFrom(String from)

Defines from.

getReplyTo

public String getReplyTo()

Returns reply to.

setReplyTo

public void setReplyTo(String replyTo)

Defines reply to.

getCc

public String getCc()

Returns cc.

setCc

public void setCc(String cc)

Sets cc.

getBcc

public String getBcc()

Returns bcc.

setBcc

public void setBcc(String bcc)

Sets bcc.

getOrganization

public String getOrganization()

Returns organization.

setOrganization

public void setOrganization(String organization)

Sets organization.

getMailboxName

public String getMailboxName()

Returns mailbox name.

setMailboxName

public void setMailboxName(String mailboxName)

Sets mail box name.

getHeaderTemplate

public String getHeaderTemplate()

returns header template.

setHeaderTemplate

public void setHeaderTemplate(String headerTemplate)

sets header template.

getFooterTemplate

public String getFooterTemplate()

Returns footer template.

setFooterTemplate

public void setFooterTemplate(String footerTemplate)

Sets footer template.

getContentTemplate

public String getContentTemplate()

Returns context template.

setContentTemplate

public void setContentTemplate(String contentTemplate)

Sets context template.

getReserved1

public int getReserved1()

setReserved1

public void setReserved1(int reserved1)

getReserved2

public int getReserved2()

setReserved2

public void setReserved2(int reserved2)

getReserved3

public int getReserved3()

setReserved3

public void setReserved3(int reserved3)