com.remedy.arsys.api
Class Escalation

java.lang.Object
  com.remedy.arsys.api.ObjectBase
      com.remedy.arsys.api.Escalation

All Implemented Interfaces:

java.lang.Cloneable, IARPersistentObject

public class Escalation

extends ObjectBase

implements IARPersistentObject, java.lang.Cloneable

The Escalation class and methods are used to represent the properties of escalation objects.

Note: All the constants used in the Escalation class are found in the Constants class.

Field Summary

Fields inherited from class com.remedy.arsys.api.ObjectBase

m_changeFlags, m_permissionList

Method Summary

void	activate() Remedy reserved method.
void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
void	create() Creates this object on the AR System server.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
boolean	equals(java.lang.Object anObject, java.lang.String lhsServer, java.lang.String rhsServer)
FilterActionInfo[]	getActionList() Returns set of actions performed if the condition defined by the query parameter is satisfied.
ARServerUser	getContext()
FilterActionInfo[]	getElseList() Returns list of actions performed if the condition defined by the query parameter is not satisfied.
long	getEnable() Returns flag indicating whether this escalation is enabled or disabled.
EscalationTmInfo	getEscalationTm() Returns the time specification for evaluating the escalation condition.
EscalationKey	getKey() Returns unique identifier for escalation.
PropInfo[]	getObjPropList() Returns list of server object property tags.
QualifierInfo	getQualifier() Returns the qualification that determines which set of If/Else actions should be executed.
WorkflowConnectInfo	getWorkflowConnect() Returns the list of form names the escalation is linked to.
int	hashCode() Returns the hash code value for this instance of the current class.
boolean	isPresent() Denotes if the field is valid.
void	load() Populates this object with information from the AR System server.
void	load(EscalationCriteria criteria) Populates this object with information specified by EscalationCriteria from the AR System server.
void	passivate() Remedy reserved method.
void	remove() Removes this object on the AR System server.
void	setActionList(FilterActionInfo[] actionList) Sets list of actions performed if the condition defined by the query parameter is satisfied.
void	setContext(ARServerUser ctx) Associates ARServerUser information with this AR System server object.
void	setDeleteOption(int option) Sets the delete option indicating the action to take if specified in the active link.
void	setElseList(FilterActionInfo[] elseList) Sets list of actions performed if the condition defined by the query parameter is not satisfied.
void	setEnable(long enable) Sets flag to enable or disable this escalation.
void	setEscalationTm(EscalationTmInfo escalationTm) Sets the time specification for evaluating the escalation condition.
void	setKey(EscalationKey key) Sets unique identifier for escalation.
void	setObjPropList(PropInfo[] objPropList) Sets list of server object property tags you can specify.
void	setQualifier(QualifierInfo query) Sets the qualification that determines which set of If/Else actions should be executed.
void	setWorkflowConnect(WorkflowConnectInfo workflowConnect) Sets the list of form names the escalation is linked to.
void	store() Updates this escalation on the database
void	unsetContext() Removes the association to a specific user context.

Methods inherited from class com.remedy.arsys.api.ObjectBase

getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, resetChangeFlags, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getContext

public ARServerUser getContext()

setContext

public void setContext(ARServerUser ctx)

Description copied from interface: IARPersistentObject

Associates ARServerUser information with this AR System server object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Description copied from interface: IARPersistentObject

Removes the association to a specific user context. This is equal to setContext(null).

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Description copied from interface: IARPersistentObject

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

Overrides:

clear in class ObjectBase

setDeleteOption

public void setDeleteOption(int option)

Sets the delete option indicating the action to take if specified in the active link.

Parameters:

option - Possible values are:

• 0: Do not delete the active link.
• 1: Delete the entire block to which the active link belongs.

create

public void create()
            throws ARException

Creates this object on the AR System server.

Specified by:

create in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not created

remove

public void remove()
            throws ARException

Removes this object on the AR System server.

Specified by:

remove in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not removed

load

public void load()
          throws ARException

Populates this object with information from the AR System server.

Specified by:

load in interface IARPersistentObject

Throws:

ARException - if object is not loaded

load

public void load(EscalationCriteria criteria)
          throws ARException

Populates this object with information specified by EscalationCriteria from the AR System server.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not loaded

store

public void store()
           throws ARException

Updates this escalation on the database

Specified by:

store in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not saved

activate

public void activate()

Remedy reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Remedy reserved method.

Specified by:

passivate in interface IARPersistentObject

isPresent

public boolean isPresent()

Denotes if the field is valid.

getEnable

public long getEnable()

Returns flag indicating whether this escalation is enabled or disabled. A value of 0 -- escalation is disabled. A value of 1 -- escalation is enabled.

setEnable

public void setEnable(long enable)

Sets flag to enable or disable this escalation. A value of 0 disables the escalation, causing its condition checks and associated actions to not be performed. A value of 1 enables the escalation, causing its conditions to be checked for each form operation specified by the getOpSet parameter.

getEscalationTm

public EscalationTmInfo getEscalationTm()

Returns the time specification for evaluating the escalation condition.

setEscalationTm

public void setEscalationTm(EscalationTmInfo escalationTm)

Sets the time specification for evaluating the escalation condition. This parameter can take one of two forms: (1) a time interval that defines how frequently the server checks the escalation condition (in seconds) or (2) a bitmask that defines a particular day (by month or week) and time (hour and minute) for the server to check the condition.

getWorkflowConnect

public WorkflowConnectInfo getWorkflowConnect()

Returns the list of form names the escalation is linked to.

setWorkflowConnect

public void setWorkflowConnect(WorkflowConnectInfo workflowConnect)

Sets the list of form names the escalation is linked to. The escalation must be associated with a single form or a list of forms that currently exists on the server.

getQualifier

public QualifierInfo getQualifier()

Returns the qualification that determines which set of If/Else actions should be executed.

setQualifier

public void setQualifier(QualifierInfo query)

Sets the qualification that determines which set of If/Else actions should be executed. Specify NULL or assign an operation value of 0 (Constants.AR_COND_OP_NONE) if the escalation has no qualification.

getObjPropList

public PropInfo[] getObjPropList()

Returns list of server object property tags.

setObjPropList

public void setObjPropList(PropInfo[] objPropList)

Sets list of server object property tags you can specify. The constant values listed below are defined by AR System:

• Constants.AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, ? BMC Software.?
• Constants.AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, ? AR System.?
• Constants.AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, ? 6.0?
• Constants.AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
• Constants.AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
• Constants.AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
• Constants.AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
• Constants.AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
• Constants.AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
• Constants.AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
• Constants.AR_OPROP_SCC_DATA_LOCKED_BY: (CHAR): Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR System server does not enforce this lock and thus it is to be considered an advisory lock only.
• Constants.AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC timestamp of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username for the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries stored in a form under revision control.

getActionList

public FilterActionInfo[] getActionList()

Returns set of actions performed if the condition defined by the query parameter is satisfied.

setActionList

public void setActionList(FilterActionInfo[] actionList)

Sets list of actions performed if the condition defined by the query parameter is satisfied. This list can contain from 1 to 25 actions (limited by Constants.AR_MAX_ACTIONS).

getElseList

public FilterActionInfo[] getElseList()

Returns list of actions performed if the condition defined by the query parameter is not satisfied.

setElseList

public void setElseList(FilterActionInfo[] elseList)

Sets list of actions performed if the condition defined by the query parameter is not satisfied. This list can contain from 0 to 25 actions (limited by Constants.AR_MAX_ACTIONS.

getKey

public EscalationKey getKey()

Returns unique identifier for escalation.

setKey

public void setKey(EscalationKey key)

Sets unique identifier for escalation.

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 ObjectBase

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.

Overrides:

equals in class ObjectBase

equals

public boolean equals(java.lang.Object anObject,
                      java.lang.String lhsServer,
                      java.lang.String rhsServer)

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 ObjectBase