AR System Java API

com.bmc.arsys.api
Class Escalation

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by com.bmc.arsys.api.Escalation
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable

public class Escalation
extends ObjectBase
implements IARPersistentObject, Cloneable, Serializable

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.

See Also:
Serialized Form

Constructor Summary
Escalation()
           
Escalation(EscalationTimeCriteria escalationTm, List<String> workflowConnect, boolean enable, QualifierInfo query, List<FilterAction> actionList, List<FilterAction> elseList, ObjectPropertyMap objPropList, String name, String helpText, int lastUpdateTime, String owner, String lastChangedBy, String diaryStr)
           
 
Method Summary
 void clear()
          Clears all of the references to member objects.
 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.
 List<FilterAction> getActionList()
          Returns set of actions performed if the condition defined by the query parameter is satisfied.
 List<FilterAction> getElseList()
          Returns list of actions performed if the condition defined by the query parameter is not satisfied.
 EscalationTimeCriteria getEscalationTm()
          Returns the time specification for evaluating the escalation condition.
 List<String> getFormList()
           
 String getKey()
          Returns unique identifier for escalation.
 String getPrimaryForm()
           
 ObjectPropertyMap getProperties()
          Returns list of server object property tags.
 QualifierInfo getQualifier()
          Returns the qualification that determines which set of If/Else actions should be executed.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isEnable()
          Returns flag indicating whether this escalation is enabled or disabled.
 void setActionList(List<FilterAction> actionList)
          Sets list of actions performed if the condition defined by the query parameter is satisfied.
 void setElseList(List<FilterAction> elseList)
          Sets list of actions performed if the condition defined by the query parameter is not satisfied.
 void setEnable(boolean enable)
          Sets flag to enable or disable this escalation.
 void setEscalationTm(EscalationTimeCriteria escalationTm)
          Sets the time specification for evaluating the escalation condition.
 void setFormList(List<String> formList)
           
 void setKey(String key)
          Sets unique identifier for escalation.
 void setPrimaryForm(String primaryForm)
           
 void setProperties(ObjectPropertyMap 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.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.ObjectBase
appendDiaryText, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.bmc.arsys.api.IARPersistentObject
appendDiaryText, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 

Constructor Detail

Escalation

public Escalation()

Escalation

public Escalation(EscalationTimeCriteria escalationTm,
                  List<String> workflowConnect,
                  boolean enable,
                  QualifierInfo query,
                  List<FilterAction> actionList,
                  List<FilterAction> elseList,
                  ObjectPropertyMap objPropList,
                  String name,
                  String helpText,
                  int lastUpdateTime,
                  String owner,
                  String lastChangedBy,
                  String diaryStr)
Method Detail

clear

public void clear()
Description copied from class: ObjectBase
Clears all of the references to member objects.

Overrides:
clear in class ObjectBase

isEnable

public boolean isEnable()
Returns flag indicating whether this escalation is enabled or disabled.


setEnable

public void setEnable(boolean 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 EscalationTimeCriteria getEscalationTm()
Returns the time specification for evaluating the escalation condition.


setEscalationTm

public void setEscalationTm(EscalationTimeCriteria 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.


getFormList

public List<String> getFormList()

setFormList

public void setFormList(List<String> formList)

getPrimaryForm

public String getPrimaryForm()

setPrimaryForm

public void setPrimaryForm(String primaryForm)

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.


getProperties

public ObjectPropertyMap getProperties()
Returns list of server object property tags.


setProperties

public void setProperties(ObjectPropertyMap objPropList)
Sets list of server object property tags you can specify. The constant values listed below are defined by AR System:


getActionList

public List<FilterAction> getActionList()
Returns set of actions performed if the condition defined by the query parameter is satisfied.


setActionList

public void setActionList(List<FilterAction> 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 List<FilterAction> getElseList()
Returns list of actions performed if the condition defined by the query parameter is not satisfied.


setElseList

public void setElseList(List<FilterAction> 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 String getKey()
Returns unique identifier for escalation.


setKey

public void setKey(String key)
Sets unique identifier for escalation.


clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class ObjectBase
Throws:
CloneNotSupportedException

equals

public boolean equals(Object obj)
Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:
equals in class ObjectBase
Parameters:
obj - the object that we are comparing to
Returns:
returns a boolean that tells if the two objects equal

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
Returns:
returns the hash code for this instance

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class ObjectBase

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.