AR System Java API

com.bmc.arsys.api
Class EscalationTime

java.lang.Object
  extended by com.bmc.arsys.api.EscalationTime
All Implemented Interfaces:
EscalationTimeCriteria, Serializable, Cloneable

public class EscalationTime
extends Object
implements EscalationTimeCriteria, Cloneable, Serializable

An escalation time uses a schedule to determine when it is executed, using either a set time or a time interval.

See Also:
Serialized Form

Constructor Summary
EscalationTime()
           
EscalationTime(BitSet monthDays, BitSet weekDays, BitSet hours, int minutes)
           
EscalationTime(int monthDaysMask, int weekDaysMask, int hoursMask, int minutes)
           
 
Method Summary
 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.
 int getHourMask()
           
 BitSet getHours()
           
 int getMinute()
           
 int getMonthDayMask()
           
 BitSet getMonthDays()
           
 int getWeekDayMask()
           
 BitSet getWeekDays()
           
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isAllMonthDays()
          Checks if the month days specification indicates all month days
 boolean isNoMonthDays()
          Checks if no month days are specified, in which case the escalation time is every chosen week day
 void setHours(BitSet hours)
           
 void setHours(int hours)
           
 void setMinute(int minute)
           
 void setMonthDays(BitSet monthDays)
           
 void setMonthDays(int monthDaysMask)
           
 void setWeekDays(BitSet weekDays)
           
 void setWeekDays(int weekDays)
           
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EscalationTime

public EscalationTime()

EscalationTime

public EscalationTime(BitSet monthDays,
                      BitSet weekDays,
                      BitSet hours,
                      int minutes)

EscalationTime

public EscalationTime(int monthDaysMask,
                      int weekDaysMask,
                      int hoursMask,
                      int minutes)
Method Detail

getHours

public BitSet getHours()

setHours

public void setHours(BitSet hours)

getMinute

public int getMinute()

setMinute

public void setMinute(int minute)

getMonthDayMask

public int getMonthDayMask()

setMonthDays

public void setMonthDays(int monthDaysMask)

isAllMonthDays

public boolean isAllMonthDays()
Checks if the month days specification indicates all month days

Returns:
true if all month days

isNoMonthDays

public boolean isNoMonthDays()
Checks if no month days are specified, in which case the escalation time is every chosen week day

Returns:
true if no month days

getWeekDayMask

public int getWeekDayMask()

setWeekDays

public void setWeekDays(int weekDays)

getHourMask

public int getHourMask()

setHours

public void setHours(int hours)

getMonthDays

public BitSet getMonthDays()

setMonthDays

public void setMonthDays(BitSet monthDays)

getWeekDays

public BitSet getWeekDays()

setWeekDays

public void setWeekDays(BitSet weekDays)

clone

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

Overrides:
clone in class Object
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 Object
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 Object
Returns:
returns the hash code for this instance

toString

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

Overrides:
toString in class Object

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.