|
7.0 Action Request System Java API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.remedy.arsys.api.NotifyActionInfo
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.
Constructor Summary | |
NotifyActionInfo()
constructor |
|
NotifyActionInfo(java.lang.String user,
java.lang.String notifyText,
long notifyPriority,
long notifyMechanism,
long notifyMechanismXRef,
java.lang.String subjectText,
long fieldIdListType,
InternalID[] fieldIdList,
long notifyBehavior,
long notifyPermission,
NotifyActionInfoAdvanced notifyActionInfoAdvanced)
|
Method Summary | |
java.lang.Object |
clone()
Clone implementation that returns an Object with data cloned from self |
boolean |
equals(java.lang.Object anObject)
Use this method for checking equality. |
InternalID[] |
getFieldIdList()
Returns list of fields whose values are included in the notification. |
long |
getFieldIdListType()
Returns fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message. |
long |
getNotifyBehavior()
Returns list of fields whose values are included in the notification. |
NotifyActionInfoAdvanced |
getNotifyInfoAdvanced()
Returns list of fields whose values are included in the notification. |
long |
getNotifyMechanism()
Returns the field ID where the notification mechanism is selected based on the getFieldIdListType() values. |
InternalID |
getNotifyMechanismXRef()
Returns users who are notified using the mechanism specified by an integer value of the given field. |
long |
getNotifyPermission()
Returns list of fields whose values are included in the notification. |
long |
getNotifyPriority()
Reserved for future use by Remedy. |
java.lang.String |
getNotifyText()
Returns text of the notification message. |
java.lang.String |
getSubjectText()
Returns subject text for the notification. |
java.lang.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 |
setFieldIdList(InternalID[] fieldIdList)
Sets list of fields whose values are included in the notification. |
void |
setFieldIdListType(long fieldIdListType)
Sets fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message. |
void |
setNotifyBehavior(long notifyBehavior)
Sets list of fields whose values are included in the notification. |
void |
setNotifyInfoAdvanced(NotifyActionInfoAdvanced notifyActionInfoAdvanced)
Sets list of fields whose values are included in the notification. |
void |
setNotifyMechanism(long notifyMechanism)
Sets the field ID where the notification mechanism is selected based on the setFieldIdListType(long) values. |
void |
setNotifyMechanismXRef(InternalID notifyMechanismXRef)
Defines users who are notified using the mechanism specified by an integer value of the given field. |
void |
setNotifyPermission(long notifyPermission)
Sets list of fields whose values are included in the notification. |
void |
setNotifyPriority(long notifyPriority)
Reserved for future use by Remedy. |
void |
setNotifyText(java.lang.String notifyText)
Defines text of the notification message. |
void |
setSubjectText(java.lang.String subjectText)
Defines subject text for the notification. |
void |
setUser(java.lang.String user)
Defines name of the users or groups to notify. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public NotifyActionInfo()
public NotifyActionInfo(java.lang.String user, java.lang.String notifyText, long notifyPriority, long notifyMechanism, long notifyMechanismXRef, java.lang.String subjectText, long fieldIdListType, InternalID[] fieldIdList, long notifyBehavior, long notifyPermission, NotifyActionInfoAdvanced notifyActionInfoAdvanced)
Method Detail |
public java.lang.String getUser()
public void setUser(java.lang.String user)
public java.lang.String getNotifyText()
public void setNotifyText(java.lang.String notifyText)
public long getNotifyPriority()
public void setNotifyPriority(long notifyPriority)
public long getNotifyMechanism()
getFieldIdListType()
values.
public void setNotifyMechanism(long notifyMechanism)
setFieldIdListType(long)
values.
public InternalID getNotifyMechanismXRef()
public void setNotifyMechanismXRef(InternalID 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 java.lang.String getSubjectText()
public void setSubjectText(java.lang.String subjectText)
public long getFieldIdListType()
fieldIdListType
that indicates whether to include all, none, selected,
or changed field whose values are included in the message.
public void setFieldIdListType(long 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 InternalID[] getFieldIdList()
public void setFieldIdList(InternalID[] fieldIdList)
public long getNotifyBehavior()
public void setNotifyBehavior(long notifyBehavior)
public long getNotifyPermission()
public void setNotifyPermission(long notifyPermission)
public NotifyActionInfoAdvanced getNotifyInfoAdvanced()
public void setNotifyInfoAdvanced(NotifyActionInfoAdvanced notifyActionInfoAdvanced)
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public boolean equals(java.lang.Object anObject)
public int hashCode()
|
7.0 Action Request System Java API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |