oracle.odi.domain.runtime.scheduling

Class Recurrence

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.PersistableValue

oracle.odi.domain.runtime.scheduling.Recurrence

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class Recurrence
extends oracle.odi.domain.support.PersistableValue

Recurrence is a value object representing the recurrence pattern of a schedule. To represent its attributes classes and enums from RecurrenceAttributes are used.

No public constructors are available in this class. Its instances should always be obtained via one of the static factory methods.

According to frequency some properties available by getter methods can be meaningless.

Since:

11.1.1.6.0

See Also:

RecurrenceAttributes, ExplicitDate, OdiSchedule, Serialized Form

Method Summary

Modifier and Type	Method and Description
static Recurrence	createDailyRecurrence(RecurrenceAttributes.TimeOfDay pTime) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.DAILY Frequency with specified time of execution.
static Recurrence	createHourlyRecurrence(int pMinute, int pSecond) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.HOURLY Frequency with specified minute and second of execution.
static Recurrence	createMonthlyByWeekDayRecurrence(RecurrenceAttributes.DayOfWeek pDayOfWeek, RecurrenceAttributes.DayOfWeekRank pDayOfWeekRank, RecurrenceAttributes.TimeOfDay pTime) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY Frequency with specified day of week, its rank in month and time of execution.
static Recurrence	createMonthlyRecurrence(RecurrenceAttributes.DayOfMonth pDayOfMonth, RecurrenceAttributes.TimeOfDay pTime) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.MONTHLY Frequency with specified day and time of execution.
static Recurrence	createOnAgentStartupRecurrence() Creates new instance of Recurrence of RecurrenceAttributes.Frequency.ON_AGENT_STARTUP Frequency.
static Recurrence	createSimpleRecurrence(ExplicitDate pDate) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.SIMPLE Frequency with specified date of execution.
static Recurrence	createWeeklyRecurrence(RecurrenceAttributes.DayOfWeek[] pDaysOfWeek, RecurrenceAttributes.TimeOfDay pTime) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.WEEKLY Frequency with specified week days and time of execution.
static Recurrence	createYearlyRecurrence(RecurrenceAttributes.MonthOfYear pMonth, RecurrenceAttributes.DayOfMonth pDay, RecurrenceAttributes.TimeOfDay pTime) Creates new instance of Recurrence of RecurrenceAttributes.Frequency.YEARLY Frequency with specified month, day and time of execution.
RecurrenceAttributes.DayOfMonth	getDayOfMonth() Returns day of recurrence.
RecurrenceAttributes.DayOfWeekRank	getDayOfWeekRank() Returns the day of week rank in month.
RecurrenceAttributes.DayOfWeek[]	getDaysOfWeek() Returns array of week days of recurrence.
RecurrenceAttributes.Frequency	getFrequency() Returns recurrence frequency.
RecurrenceAttributes.MonthOfYear	getMonth() Returns month of recurrence.
RecurrenceAttributes.TimeOfDay	getTime() Returns time of recurrence.
RecurrenceAttributes.Year	getYear() Returns year of recurrence.

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

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

Method Detail

createYearlyRecurrence

public static Recurrence createYearlyRecurrence(RecurrenceAttributes.MonthOfYear pMonth,
                                                RecurrenceAttributes.DayOfMonth pDay,
                                                RecurrenceAttributes.TimeOfDay pTime)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.YEARLY Frequency with specified month, day and time of execution.

Parameters:

pMonth - month

pDay - day

pTime - time

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified month, day or time is null

createMonthlyRecurrence

public static Recurrence createMonthlyRecurrence(RecurrenceAttributes.DayOfMonth pDayOfMonth,
                                                 RecurrenceAttributes.TimeOfDay pTime)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.MONTHLY Frequency with specified day and time of execution.

Parameters:

pDayOfMonth - day

pTime - time

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified day or time is null

createMonthlyByWeekDayRecurrence

public static Recurrence createMonthlyByWeekDayRecurrence(RecurrenceAttributes.DayOfWeek pDayOfWeek,
                                                          RecurrenceAttributes.DayOfWeekRank pDayOfWeekRank,
                                                          RecurrenceAttributes.TimeOfDay pTime)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY Frequency with specified day of week, its rank in month and time of execution.

Parameters:

pDayOfWeek - day of week

pDayOfWeekRank - day of week rank

pTime - time

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified day of week, rank or time is null

createWeeklyRecurrence

public static Recurrence createWeeklyRecurrence(RecurrenceAttributes.DayOfWeek[] pDaysOfWeek,
                                                RecurrenceAttributes.TimeOfDay pTime)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.WEEKLY Frequency with specified week days and time of execution.

Parameters:

pDaysOfWeek - array of week days

pTime - time

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified array of week days is null or empty; specified time is null

createDailyRecurrence

public static Recurrence createDailyRecurrence(RecurrenceAttributes.TimeOfDay pTime)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.DAILY Frequency with specified time of execution.

Parameters:

pTime - time

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified time is null

createHourlyRecurrence

public static Recurrence createHourlyRecurrence(int pMinute,
                                                int pSecond)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.HOURLY Frequency with specified minute and second of execution.

Parameters:

pMinute - minute of execution

pSecond - second of execution

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if passed values are not between 0 and 59

createOnAgentStartupRecurrence

public static Recurrence createOnAgentStartupRecurrence()

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.ON_AGENT_STARTUP Frequency.

Returns:

new instance of Recurrence

createSimpleRecurrence

public static Recurrence createSimpleRecurrence(ExplicitDate pDate)

Creates new instance of Recurrence of RecurrenceAttributes.Frequency.SIMPLE Frequency with specified date of execution.

Parameters:

pDate - date

Returns:

new instance of Recurrence

Throws:

DomainRuntimeException - if specified date is null

getFrequency

public RecurrenceAttributes.Frequency getFrequency()

Returns recurrence frequency.

Returns:

frequency

getTime

public RecurrenceAttributes.TimeOfDay getTime()

Returns time of recurrence.

Not Relevant for RecurrenceAttributes.Frequency.ON_AGENT_STARTUP frequency.

Returns:

time

See Also:

getFrequency()

getMonth

public RecurrenceAttributes.MonthOfYear getMonth()

Returns month of recurrence.

Relevant for RecurrenceAttributes.Frequency.YEARLY and RecurrenceAttributes.Frequency.SIMPLE frequencies only.

Returns:

month

See Also:

getFrequency()

getDayOfWeekRank

public RecurrenceAttributes.DayOfWeekRank getDayOfWeekRank()

Returns the day of week rank in month.

Relevant for RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY frequency only.

Returns:

day of week rank

See Also:

getFrequency()

getDaysOfWeek

public RecurrenceAttributes.DayOfWeek[] getDaysOfWeek()

Returns array of week days of recurrence.

Relevant for RecurrenceAttributes.Frequency.WEEKLY and RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY frequencies only.

Returns:

week days array

See Also:

getFrequency()

getDayOfMonth

public RecurrenceAttributes.DayOfMonth getDayOfMonth()

Returns day of recurrence.

Relevant for RecurrenceAttributes.Frequency.MONTHLY and RecurrenceAttributes.Frequency.SIMPLE frequencies only.

Returns:

day

See Also:

getFrequency()

getYear

public RecurrenceAttributes.Year getYear()

Returns year of recurrence.

Relevant for RecurrenceAttributes.Frequency.SIMPLE frequency only.

Returns:

year

See Also:

getFrequency()