AR System Java API

com.bmc.arsys.api
Class DayInfo

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

public class DayInfo
extends Object
implements Cloneable, Serializable

The DayInfo class is used to specify date and time information in defining escalation firing time.

See Also:
Serialized Form

Constructor Summary
DayInfo()
          constructor
DayInfo(long monthday, long weekday, long hourmask, long minute)
           
 
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.
 long getHourmask()
          Returns hours of day.
 long getMinute()
          Returns minutes of the hour.
 long getMonthday()
          Returns the set of days in the month.
 long getWeekday()
          Returns days of week.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setHourmask(long hourmask)
          Sets hours of day.
 void setMinute(long minute)
          Sets minutes of the hour.
 void setMonthday(long monthday)
          Sets the days in the month.
 void setWeekday(long weekday)
          Sets days of week.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DayInfo

public DayInfo()
constructor


DayInfo

public DayInfo(long monthday,
               long weekday,
               long hourmask,
               long minute)
Method Detail

getMonthday

public long getMonthday()
Returns the set of days in the month. The bits 0 to 30 of the returned value day represent days 1 to 31 of a month.


setMonthday

public void setMonthday(long monthday)
Sets the days in the month. The bits 0 to 30 represent days 1 to 31 of a month. To set a day, set its corresponding bit. In months that do not have 31 days, bit 30 represents the last day of the month. To set multiple days, add the bits representing their days together. For example, to set the 1st and 15th, use 16385, the sum of bit 0 (1) + bit 15 (16384).


getWeekday

public long getWeekday()
Returns days of week. The bits 0 to 6 of the returned value day represent Sunday to Saturday of a week.


setWeekday

public void setWeekday(long weekday)
Sets days of week. The bits 0 to 6 represent Sunday to Saturday of a week. To set any day of the week, set its corresponding bit. To set multiple days of the week, add the bits representing their days together.


getHourmask

public long getHourmask()
Returns hours of day. The bits 0 to 23 of the returned value hourmask represent hours 0 to 23 of a day.


setHourmask

public void setHourmask(long hourmask)
Sets hours of day. The bits 0 to 23 represent hours 0 to 23 of a day. To set any hour of the day, set its corresponding bit. To set multiple hours, add the bits representing their hours together.


getMinute

public long getMinute()
Returns minutes of the hour.


setMinute

public void setMinute(long minute)
Sets minutes of the hour.


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.