com.remedy.arsys.api
Class EscalationTmInfo

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

public class EscalationTmInfo

extends java.lang.Object

implements java.lang.Cloneable

The EscalationTmInfo class represents the time specification for evaluating the escalation condition. This parameter can take one of two forms:

• A time interval that defines how frequently the server checks the escalation condition (in seconds)
• A bitmask that defines a particular day (by month or week) and time (hour and minute) for the server to check the condition.

Constructor Summary

EscalationTmInfo()
Constructor

EscalationTmInfo(DayInfo date)
Constructs a new EscalationTmInfo object using Constants.AR_ESCALATION_TYPE_TIMEMARK to define a particular day

EscalationTmInfo(long interval)
Constructs a new EscalationTmInfo object using Constants.AR_ESCALATION_TYPE_INTERVAL to define a time interval

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
DayInfo	getDate() Returns time information for specified escalation.
int	getEscalationTmType() Returns the time specification for evaluating the escalation condition.
long	getInterval() Returns interval information for specified escalation.
void	setDate(DayInfo date) Sets time information for specified escalation.
void	setEscalationTmType(int escalationTmType) Sets the time specification for evaluating the escalation condition.
void	setInterval(long interval) Sets interval information for specified escalation.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EscalationTmInfo

public EscalationTmInfo()

Constructor

EscalationTmInfo

public EscalationTmInfo(long interval)

Constructs a new EscalationTmInfo object using Constants.AR_ESCALATION_TYPE_INTERVAL to define a time interval

Parameters:

interval - escalation fire time in seconds

EscalationTmInfo

public EscalationTmInfo(DayInfo date)

Constructs a new EscalationTmInfo object using Constants.AR_ESCALATION_TYPE_TIMEMARK to define a particular day

Parameters:

DayInfo - escalation fire date

Method Detail

getInterval

public long getInterval()

Returns interval information for specified escalation.

setInterval

public void setInterval(long interval)

Sets interval information for specified escalation.

getDate

public DayInfo getDate()

Returns time information for specified escalation.

setDate

public void setDate(DayInfo date)

Sets time information for specified escalation.

getEscalationTmType

public int getEscalationTmType()

Returns the time specification for evaluating the escalation condition. Specify NULL for this parameter if you do not want to retrieve the escalation time. Valid values are: Constants.AR_ESCALATION_TYPE_INTERVAL that defines how frequently the server checks the escalation condition (in seconds) Constants.AR_ESCALATION_TYPE_TIMEMARK that defines a particular day (by month or week)and time (hour and minute)for the server to check the condition.

setEscalationTmType

public void setEscalationTmType(int escalationTmType)

Sets the time specification for evaluating the escalation condition. Specify NULL for this parameter if you do not want to retrieve the escalation time. Valid values are: Constants.AR_ESCALATION_TYPE_INTERVAL that defines how frequently the server checks the escalation condition (in seconds) Constants.AR_ESCALATION_TYPE_TIMEMARK that defines a particular day (by month or week)and time (hour and minute)for the server to check the condition.

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