com.remedy.arsys.api
Class NotifyActionInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.NotifyActionInfo

All Implemented Interfaces:

java.lang.Cloneable

public class NotifyActionInfo

extends java.lang.Object

implements java.lang.Cloneable

The NotifyActionInfo class is used to to send a message to specified users or groups by email, AR System 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 AR System Corporation.
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() This method can be used to populate a hash table.
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 AR System Corporation.
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

NotifyActionInfo

public NotifyActionInfo()

constructor

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

getUser

public java.lang.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(java.lang.String user)

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

getNotifyText

public java.lang.String getNotifyText()

Returns text of the notification message.

setNotifyText

public void setNotifyText(java.lang.String notifyText)

Defines text of the notification message.

getNotifyPriority

public long getNotifyPriority()

Reserved for future use by AR System Corporation.

setNotifyPriority

public void setNotifyPriority(long notifyPriority)

Reserved for future use by AR System Corporation.

getNotifyMechanism

public long getNotifyMechanism()

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

setNotifyMechanism

public void setNotifyMechanism(long notifyMechanism)

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

getNotifyMechanismXRef

public InternalID getNotifyMechanismXRef()

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

setNotifyMechanismXRef

public void setNotifyMechanismXRef(InternalID 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 -- AR System 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 java.lang.String getSubjectText()

Returns subject text for the notification.

setSubjectText

public void setSubjectText(java.lang.String subjectText)

Defines subject text for the notification.

getFieldIdListType

public long 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(long 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 InternalID[] getFieldIdList()

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

setFieldIdList

public void setFieldIdList(InternalID[] fieldIdList)

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

getNotifyBehavior

public long getNotifyBehavior()

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

setNotifyBehavior

public void setNotifyBehavior(long notifyBehavior)

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

getNotifyPermission

public long getNotifyPermission()

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

setNotifyPermission

public void setNotifyPermission(long notifyPermission)

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

getNotifyInfoAdvanced

public NotifyActionInfoAdvanced getNotifyInfoAdvanced()

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

setNotifyInfoAdvanced

public void setNotifyInfoAdvanced(NotifyActionInfoAdvanced notifyActionInfoAdvanced)

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object