oracle.lite.job

Class Schedule

java.lang.Object

oracle.lite.job.Schedule

public class Schedule
extends java.lang.Object

This class encapsulates the job schedule information. To create job using the createJob() method of ConsolidatorManager class, a user needs to provide an object of this Schedule class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERVAL
static int	MONTHLY
static int	ONE_TIME_ONLY
static int	WEEKLY

Constructor Summary

Constructors

Constructor and Description
Schedule(java.util.Date startTime, int expireLimit) Constructor for a non-repeatable job.
Schedule(java.util.Date startTime, int expireLimit, int repeatMode, int repeatInterval, int repeatWeeklyFrequency, java.lang.String repeatDaysOfWeek, int repeatMonthlyFrequency, java.lang.String repeatDaysOfMonth, java.util.Date repeatUntilTime) Constructor for a repeatable job.

Method Summary

Methods

Modifier and Type	Method and Description
int	getExpireLimit() Job expire limit in minutes.
java.lang.String	getRepeatDaysOfMonth() Space separated month days on which the job will be executed.
java.lang.String	getRepeatDaysOfWeek() Space separated week days on which the job will be executed.
int	getRepeatInterval() Job repeat interval in seconds.
int	getRepeatMode() Job repeat mode.
int	getRepeatMonthlyFrequency() Job monthly repeat frequency.
java.util.Date	getRepeatUntilTime() Repeat until time.
int	getRepeatWeeklyFrequency() Job weekly repeat frequency.
java.util.Date	getStartTime() Job start time.

Methods inherited from class java.lang.Object

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

Field Detail

INTERVAL

public static final int INTERVAL

See Also:

Constant Field Values

MONTHLY

public static final int MONTHLY

See Also:

Constant Field Values

ONE_TIME_ONLY

public static final int ONE_TIME_ONLY

See Also:

Constant Field Values

WEEKLY

public static final int WEEKLY

See Also:

Constant Field Values

Constructor Detail

Schedule

public Schedule(java.util.Date startTime,
        int expireLimit)

Constructor for a non-repeatable job.

Parameters:

startTime - Job start date and time. If null, the current time will be used.

expireLimit - Job expire limit in minutes. Job will be canceled if not started within the limit. A negative or zero value means never expire.

Schedule

public Schedule(java.util.Date startTime,
        int expireLimit,
        int repeatMode,
        int repeatInterval,
        int repeatWeeklyFrequency,
        java.lang.String repeatDaysOfWeek,
        int repeatMonthlyFrequency,
        java.lang.String repeatDaysOfMonth,
        java.util.Date repeatUntilTime)

Constructor for a repeatable job.

Parameters:

startTime - Job start date and time. The time of day extracted from startTime will also be used for weekly and monthly repeats. If null, the current time will be used.

expireLimit - Job expire limit in minutes. Job will be canceled if not started within the limit. A negative or zero value means never expire.

repeatMode - Repeat mode. Acceptable values are Schedule.ONE_TIME_ONLY, Schedule.INTERVAL, Schedule.WEEKLY and Schedule.MONTHLY.

repeatInterval - Job repeat interval in seconds. A negative or zero value means no interval repeats.

repeatWeeklyFrequency - Job weekly repeat frequency. Job is executed every this number of weeks. A negative or zero value means no weekly repeat.

repeatDaysOfWeek - Space separated week days on which the job will be executed. Valid days are "Monday" through "Friday", "Saturday", "Sunday" and "Everyday". A null or empty value means no weekly repeat.

repeatMonthlyFrequency - Job monthly repeat frequency. Job is executed every this number of months. A negative or zero value means no monthly repeat.

repeatDaysOfMonth - Space separated month days on which the job will be executed. Valid days are "1" through "32". "32" means the last day of months. A null or empty value means no monthly repeat.

repeatUntilTime - Repeat until time. The job will be executed according to the repeat settings until this date is reached.

Method Detail

getExpireLimit

public int getExpireLimit()

Job expire limit in minutes.

Returns:

Job expire limit in minutes.

getRepeatDaysOfMonth

public java.lang.String getRepeatDaysOfMonth()

Space separated month days on which the job will be executed. Valid days are "1" through "32". "32" means the last day of months. A null or empty value means no monthly repeat.

Returns:

Space separated month days on which the job will be executed.

getRepeatDaysOfWeek

public java.lang.String getRepeatDaysOfWeek()

Space separated week days on which the job will be executed. Valid days are "Monday" through "Friday", "Saturday", "Sunday" and "Everyday". A null or empty value means no weekly repeat.

Returns:

Space separated weekdays on which the job will be executed.

getRepeatInterval

public int getRepeatInterval()

Job repeat interval in seconds.

Returns:

Job repeat interval in seconds.

getRepeatMode

public int getRepeatMode()

Job repeat mode.

Returns:

Repeat mode. Possible values are Schedule.ONE_TIME_ONLY, Schedule.INTERVAL, Schedule.WEEKLY and Schedule.MONTHLY.

getRepeatMonthlyFrequency

public int getRepeatMonthlyFrequency()

Job monthly repeat frequency. Job is executed every this number of months. A negative or zero value means no monthly repeat.

Returns:

Job monthly repeat frequency.

getRepeatUntilTime

public java.util.Date getRepeatUntilTime()

Repeat until time. The job will be executed according to the repeat settings until this date is reached.

Returns:

Repeat until time.

getRepeatWeeklyFrequency

public int getRepeatWeeklyFrequency()

Job weekly repeat frequency. Job is executed every this number of weeks. A negative or zero value means no weekly repeat.

Returns:

Job weekly repeat frequency.

getStartTime

public java.util.Date getStartTime()

Job start time.

Returns:

Job start time.