ibi.broker.api.data.schedule
Class TimeInfo

java.lang.Object
  ibi.broker.api.data.schedule.TimeInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TimeInfoCustom, TimeInfoDay, TimeInfoMinute, TimeInfoMonth, TimeInfoOnce

public abstract class TimeInfo
extends java.lang.Object
implements java.io.Serializable

 The TimeInfo class is an abstract class used to represent time-related 
 information as it pertains to scheduling within ReportCaster. The classes
 that directly extend this class are: TimeInfoDay, TimeInfoMinute, TimeInfoMonth, 
 and TimeInfoOnce. Other classes that are indirect extensions include: TimeInfoHour,
 TimeInfoWeek, and TimeInfoYear.
 

See Also:

Serialized Form

Field Summary

static int	CUSTOM
static int	DAY Interval type indicating execution daily.
protected java.lang.String	description
static int	HOUR Interval type indicating execution hourly.
protected java.lang.String	id
static int	MINUTE Interval type indicating execution every minute.
static int	MONTH Interval type indicating execution monthly.
protected java.lang.String	name
static int	ONCE Interval type indicating one-time execution.
static int	WEEK Interval type indicating execution weekly.
static int	YEAR Interval type indicating execution yearly.

Constructor Summary

TimeInfo()

Method Summary

java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getName()
java.util.Calendar	getNextRunTime() Obtains a Java Calendar Object indicating the next run time for a scheduled event.
java.util.Calendar	getStartTime() Obtains a Java Calendar Object indicating the start time for a scheduled event.
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setNextRunTime(java.util.Calendar nextRunTime) Assigns a Java Calendar Object indicating the next run time for a scheduled event.
void	setStartTime(java.util.Calendar startTime) Assigns a Java Calendar Object indicating the start time for a scheduled event.

Methods inherited from class java.lang.Object

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

Field Detail

ONCE

public static final int ONCE

Interval type indicating one-time execution.

See Also:

MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, Constant Field Values

MINUTE

public static final int MINUTE

Interval type indicating execution every minute.

See Also:

ONCE, HOUR, DAY, WEEK, MONTH, YEAR, Constant Field Values

HOUR

public static final int HOUR

Interval type indicating execution hourly.

See Also:

ONCE, MINUTE, DAY, WEEK, MONTH, YEAR, Constant Field Values

DAY

public static final int DAY

Interval type indicating execution daily.

See Also:

ONCE, MINUTE, HOUR, WEEK, MONTH, YEAR, Constant Field Values

WEEK

public static final int WEEK

Interval type indicating execution weekly.

See Also:

ONCE, MINUTE, HOUR, DAY, MONTH, YEAR, Constant Field Values

MONTH

public static final int MONTH

Interval type indicating execution monthly.

See Also:

ONCE, MINUTE, HOUR, DAY, WEEK, YEAR, Constant Field Values

YEAR

public static final int YEAR

Interval type indicating execution yearly.

See Also:

ONCE, MINUTE, HOUR, DAY, WEEK, MONTH, Constant Field Values

CUSTOM

public static final int CUSTOM

See Also:

Constant Field Values

id

protected java.lang.String id

name

protected java.lang.String name

description

protected java.lang.String description

Constructor Detail

TimeInfo

public TimeInfo()

Method Detail

getNextRunTime

public java.util.Calendar getNextRunTime()

Obtains a Java Calendar Object indicating the next run time for a scheduled event. NextRunTime is rendered by an internal calculation based on interval, frequency, and start time, and determines the run time for any scheduled job subsequent to the initial job designated by the start time. As the Java Calendar class is an abstract class, the actual instance object involved is a GregorianCalendar.

Returns:

A Calendar object indicating the next run time of the schedule.

See Also:

setNextRunTime(java.util.Calendar)

setNextRunTime

public void setNextRunTime(java.util.Calendar nextRunTime)

Assigns a Java Calendar Object indicating the next run time for a scheduled event. The method setNextRunTime() is generally used only as an internal method. It is not recommended for general usage, and is not formally supported. Manually re-setting system designated fields might result in unpredictable behavior. However, the expected behavior if a user or programmer uses setNextRunTime() to designate a next run time that is different from the run time calculated internally is that the scheduled job will run at the new next run time, then resume normal calculation. As the Java Calendar class is an abstract class, the actual instance object involved is a GregorianCalendar.

Parameters:

nextRunTime - A Calendar object indicating the next run time of the schedule.

See Also:

getNextRunTime()

getStartTime

public java.util.Calendar getStartTime()

Obtains a Java Calendar Object indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. After the first time a schedule runs, subsequent run times can be obtained via the getNextRunTime method. A call to getStartTime() after the first job of this schedule has run will return the initial start time value when the schedule was created. The default start time is the current time. As the Java Calendar class is an abstract class, the actual instance object involved is a GregorianCalendar.

Returns:

The start time as a Calendar object.

See Also:

setStartTime(java.util.Calendar)

setStartTime

public void setStartTime(java.util.Calendar startTime)

Assigns a Java Calendar Object indicating the start time for a scheduled event. The start time is designated as the first time a new schedule is set to run. A call to setStartTime() after the first job of this schedule has run will create an entirely new start time, in essence, creating a new schedule and altering any jobs that are to run in the future. The default start time is the current time. After the first time a schedule runs, subsequent run times can be obtained via the getNextRunTime() method. As the Java Calendar class is an abstract class, the actual instance object involved is a GregorianCalendar.

Parameters:

startTime - A Calendar object indicating the start time of a specific schedule.

See Also:

getStartTime()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)