public class NotifyAction extends Action implements FilterAction, Cloneable, Serializable
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.Constructor and Description |
---|
NotifyAction()
constructor
|
NotifyAction(String user,
String notifyText,
int notifyPriority,
int notifyMechanism,
int notifyMechanismXRef,
String subjectText,
int fieldIdListType,
List<Integer> fieldIdList,
int notifyBehavior,
int notifyPermission) |
Modifier and Type | Method and Description |
---|---|
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.
|
equals, getActionType
public String getUser()
public void setUser(String user)
public String getNotifyText()
public void setNotifyText(String notifyText)
public int getNotifyPriority()
public void setNotifyPriority(int notifyPriority)
public int getNotifyMechanism()
getFieldIdListType()
values.public void setNotifyMechanism(int notifyMechanism)
setFieldIdListType(int)
values.public int getNotifyMechanismXRef()
public void setNotifyMechanismXRef(int notifyMechanismXRef)
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.
public String getSubjectText()
public void setSubjectText(String subjectText)
public int getFieldIdListType()
fieldIdListType
that indicates whether to include all, none, selected,
or changed field whose values are included in the message.public void setFieldIdListType(int fieldIdListType)
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.
public List<Integer> getFieldIdList()
public void setFieldIdList(List<Integer> fieldIdList)
public int getNotifyBehavior()
public void setNotifyBehavior(int notifyBehavior)
public int getNotifyPermission()
public void setNotifyPermission(int notifyPermission)
public Object clone() throws CloneNotSupportedException
clone
in class Action
CloneNotSupportedException
public boolean equals(Object obj)
public int hashCode()
public String toString()
public String getFrom()
public void setFrom(String from)
public String getReplyTo()
public void setReplyTo(String replyTo)
public String getCc()
public void setCc(String cc)
public String getBcc()
public void setBcc(String bcc)
public String getOrganization()
public void setOrganization(String organization)
public String getMailboxName()
public void setMailboxName(String mailboxName)
public String getHeaderTemplate()
public void setHeaderTemplate(String headerTemplate)
public String getFooterTemplate()
public void setFooterTemplate(String footerTemplate)
public String getContentTemplate()
public void setContentTemplate(String contentTemplate)
public int getReserved1()
public void setReserved1(int reserved1)
public int getReserved2()
public void setReserved2(int reserved2)
public int getReserved3()
public void setReserved3(int reserved3)
? Copyright 2013 BMC Software, Inc.