public final class Recurrence
extends oracle.odi.domain.support.PersistableValue
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.
RecurrenceAttributes
,
ExplicitDate
,
OdiSchedule
,
Serialized FormModifier 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.
|
public static Recurrence createYearlyRecurrence(RecurrenceAttributes.MonthOfYear pMonth, RecurrenceAttributes.DayOfMonth pDay, RecurrenceAttributes.TimeOfDay pTime)
RecurrenceAttributes.Frequency.YEARLY
Frequency
with specified month, day and time of execution.pMonth
- monthpDay
- daypTime
- timeDomainRuntimeException
- if specified month, day or time is nullpublic static Recurrence createMonthlyRecurrence(RecurrenceAttributes.DayOfMonth pDayOfMonth, RecurrenceAttributes.TimeOfDay pTime)
RecurrenceAttributes.Frequency.MONTHLY
Frequency
with specified day and time of execution.pDayOfMonth
- daypTime
- timeDomainRuntimeException
- if specified day or time is nullpublic static Recurrence createMonthlyByWeekDayRecurrence(RecurrenceAttributes.DayOfWeek pDayOfWeek, RecurrenceAttributes.DayOfWeekRank pDayOfWeekRank, RecurrenceAttributes.TimeOfDay pTime)
RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY
Frequency with specified day of week, its rank in month and time of
execution.pDayOfWeek
- day of weekpDayOfWeekRank
- day of week rankpTime
- timeDomainRuntimeException
- if specified day of week, rank or time is
nullpublic static Recurrence createWeeklyRecurrence(RecurrenceAttributes.DayOfWeek[] pDaysOfWeek, RecurrenceAttributes.TimeOfDay pTime)
RecurrenceAttributes.Frequency.WEEKLY
Frequency
with specified week days and time of execution.pDaysOfWeek
- array of week dayspTime
- timeDomainRuntimeException
- if specified array of week days is null or
empty; specified time is nullpublic static Recurrence createDailyRecurrence(RecurrenceAttributes.TimeOfDay pTime)
RecurrenceAttributes.Frequency.DAILY
Frequency
with specified time of execution.pTime
- timeDomainRuntimeException
- if specified time is nullpublic static Recurrence createHourlyRecurrence(int pMinute, int pSecond)
RecurrenceAttributes.Frequency.HOURLY
Frequency
with specified minute and second of execution.pMinute
- minute of executionpSecond
- second of executionDomainRuntimeException
- if passed values are not between 0 and 59public static Recurrence createOnAgentStartupRecurrence()
RecurrenceAttributes.Frequency.ON_AGENT_STARTUP
Frequency.public static Recurrence createSimpleRecurrence(ExplicitDate pDate)
RecurrenceAttributes.Frequency.SIMPLE
Frequency
with specified date of execution.pDate
- dateDomainRuntimeException
- if specified date is nullpublic RecurrenceAttributes.Frequency getFrequency()
public RecurrenceAttributes.TimeOfDay getTime()
Not Relevant for RecurrenceAttributes.Frequency.ON_AGENT_STARTUP
frequency.
getFrequency()
public RecurrenceAttributes.MonthOfYear getMonth()
Relevant for RecurrenceAttributes.Frequency.YEARLY
and RecurrenceAttributes.Frequency.SIMPLE
frequencies only.
getFrequency()
public RecurrenceAttributes.DayOfWeekRank getDayOfWeekRank()
Relevant for RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY
frequency only.
getFrequency()
public RecurrenceAttributes.DayOfWeek[] getDaysOfWeek()
Relevant for RecurrenceAttributes.Frequency.WEEKLY
and
RecurrenceAttributes.Frequency.MONTHLY_BY_WEEK_DAY
frequencies only.
getFrequency()
public RecurrenceAttributes.DayOfMonth getDayOfMonth()
Relevant for RecurrenceAttributes.Frequency.MONTHLY
and RecurrenceAttributes.Frequency.SIMPLE
frequencies only.
getFrequency()
public RecurrenceAttributes.Year getYear()
Relevant for RecurrenceAttributes.Frequency.SIMPLE
frequency only.
getFrequency()