7.0 Action Request System Java API

com.remedy.arsys.api
Class NotifyActionInfo

java.lang.Object
  extended bycom.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, 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

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 Remedy.


setNotifyPriority

public void setNotifyPriority(long notifyPriority)
Reserved for future use by Remedy.


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):


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:


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

Throws:
java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)
Use this method for checking equality. The result is true only if the argument is not null, is of same type and represents the same content.


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.


7.0 Action Request System Java API