oracle.as.scheduler
Class RecurrenceFields.TIME_OF_DAY

java.lang.Object
  oracle.as.scheduler.RecurrenceFields.TIME_OF_DAY

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

RecurrenceFields

public static class RecurrenceFields.TIME_OF_DAY
extends java.lang.Object
implements java.io.Serializable

Defines the time of the day. The time of the day is defined in the format HH:MM:SS where

 
          HH - represents the hour part of the time. Valid values are between 0 and 23.
          MM - represents the minute within the hour. Valid values are between 0 and 59.
          SS - represents the seconds within the minutes. Valid values are between 0 and 59.
 

This class only supports the 24-hour clock. No public constructors are exposed by this clas. An instance should always be obtained via the valueOf method provided.

See Also:

Serialized Form

Field Summary

static int	MAX_HOUR_VALUE Maximum possible value for Hour part (HH).
static int	MAX_MINUTE_VALUE Maximum possible value for Minute part (MM).
static int	MAX_SECOND_VALUE Maximum possible value for Second part (SS).

Method Summary

int	getHour() Method to get the hour part of this TIME_OF_DAY instance.
int	getMinute() Method to get the minute part of this TIME_OF_DAY instance.
int	getSecond() Method to get the second part of this TIME_OF_DAY instance.
void	setHour(int hour) Method to set the hour part of this TIME_OF_DAY instance.
void	setMinute(int minute) Method to set the minute part of this TIME_OF_DAY instance.
void	setSecond(int second) Method to set the second part of this TIME_OF_DAY instance.
java.lang.String	toString() Method to retrieve String representation of this TIME_OF_DAY.
static RecurrenceFields.TIME_OF_DAY	valueOf(int hour, int minute, int second) Returns an instance of TIME_OF_DAY representing the time specified by given values for hour, minute, and second.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HOUR_VALUE

public static final int MAX_HOUR_VALUE

Maximum possible value for Hour part (HH).

See Also:

Constant Field Values

MAX_MINUTE_VALUE

public static final int MAX_MINUTE_VALUE

Maximum possible value for Minute part (MM).

See Also:

Constant Field Values

MAX_SECOND_VALUE

public static final int MAX_SECOND_VALUE

Maximum possible value for Second part (SS).

See Also:

Constant Field Values

Method Detail

valueOf

public static RecurrenceFields.TIME_OF_DAY valueOf(int hour,
                                                   int minute,
                                                   int second)
                                            throws IllegalArgumentException

Returns an instance of TIME_OF_DAY representing the time specified by given values for hour, minute, and second. All the values must be within the allowed range.

Parameters:

hour - - the hour part of the time.

minute - - the minutes within the hour.

second - - the seconds within the minute.

Returns:

- an instance of TIME_OF_DAY representing the time specified by hour, minute, second.

Throws:

IllegalArgumentException - - thrown if hour, minute and second do not have legal values.

getHour

public int getHour()

Method to get the hour part of this TIME_OF_DAY instance.

Returns:

- the hour part as int.

setHour

public void setHour(int hour)
             throws IllegalArgumentException

Method to set the hour part of this TIME_OF_DAY instance.

Parameters:

hour - - the hour to be set. The value must be between 0 and 23.

Throws:

IllegalArgumentException - - thrown if the value specified is not a legal value.

getMinute

public int getMinute()

Method to get the minute part of this TIME_OF_DAY instance.

Returns:

- the minute part as int.

setMinute

public void setMinute(int minute)
               throws IllegalArgumentException

Method to set the minute part of this TIME_OF_DAY instance.

Parameters:

minute - - the minute to be set. The value must be between 0 and 59.

Throws:

IllegalArgumentException - - thrown if the value specified is not a legal value.

getSecond

public int getSecond()

Method to get the second part of this TIME_OF_DAY instance.

Returns:

- the second part as int.

setSecond

public void setSecond(int second)
               throws IllegalArgumentException

Method to set the second part of this TIME_OF_DAY instance.

Parameters:

second - - the second to be set. The value must be between 0 and 59.

Throws:

IllegalArgumentException - - thrown if the value specified is not a legal value.

toString

public java.lang.String toString()

Method to retrieve String representation of this TIME_OF_DAY. The method uses colon (:) as the field separator.

Overrides:

toString in class java.lang.Object

Returns:

- String representing this TIME_OF_DAY in the HH:MM:SS format.