Class ScheduledInstanceRecurrence
- All Implemented Interfaces:
Serializable,Cloneable
Describes the recurring schedule for a Scheduled Instance.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()booleanThe frequency (Daily,Weekly, orMonthly).The interval quantity.The days.Indicates whether the occurrence is relative to the end of the specified week or month.The unit foroccurrenceDaySet(DayOfWeekorDayOfMonth).inthashCode()Indicates whether the occurrence is relative to the end of the specified week or month.voidsetFrequency(String frequency) The frequency (Daily,Weekly, orMonthly).voidsetInterval(Integer interval) The interval quantity.voidsetOccurrenceDaySet(Collection<Integer> occurrenceDaySet) The days.voidsetOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd) Indicates whether the occurrence is relative to the end of the specified week or month.voidsetOccurrenceUnit(String occurrenceUnit) The unit foroccurrenceDaySet(DayOfWeekorDayOfMonth).toString()Returns a string representation of this object; useful for testing and debugging.withFrequency(String frequency) The frequency (Daily,Weekly, orMonthly).withInterval(Integer interval) The interval quantity.withOccurrenceDaySet(Integer... occurrenceDaySet) The days.withOccurrenceDaySet(Collection<Integer> occurrenceDaySet) The days.withOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd) Indicates whether the occurrence is relative to the end of the specified week or month.withOccurrenceUnit(String occurrenceUnit) The unit foroccurrenceDaySet(DayOfWeekorDayOfMonth).
-
Constructor Details
-
ScheduledInstanceRecurrence
public ScheduledInstanceRecurrence()
-
-
Method Details
-
setFrequency
The frequency (
Daily,Weekly, orMonthly).- Parameters:
frequency- The frequency (Daily,Weekly, orMonthly).
-
getFrequency
The frequency (
Daily,Weekly, orMonthly).- Returns:
- The frequency (
Daily,Weekly, orMonthly).
-
withFrequency
The frequency (
Daily,Weekly, orMonthly).- Parameters:
frequency- The frequency (Daily,Weekly, orMonthly).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInterval
The interval quantity. The interval unit depends on the value of
frequency. For example, every 2 weeks or every 2 months.- Parameters:
interval- The interval quantity. The interval unit depends on the value offrequency. For example, every 2 weeks or every 2 months.
-
getInterval
The interval quantity. The interval unit depends on the value of
frequency. For example, every 2 weeks or every 2 months.- Returns:
- The interval quantity. The interval unit depends on the value of
frequency. For example, every 2 weeks or every 2 months.
-
withInterval
The interval quantity. The interval unit depends on the value of
frequency. For example, every 2 weeks or every 2 months.- Parameters:
interval- The interval quantity. The interval unit depends on the value offrequency. For example, every 2 weeks or every 2 months.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getOccurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
- Returns:
- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
-
setOccurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
- Parameters:
occurrenceDaySet- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
-
withOccurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
NOTE: This method appends the values to the existing list (if any). Use
setOccurrenceDaySet(java.util.Collection)orwithOccurrenceDaySet(java.util.Collection)if you want to override the existing values.- Parameters:
occurrenceDaySet- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withOccurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
- Parameters:
occurrenceDaySet- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOccurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
- Parameters:
occurrenceRelativeToEnd- Indicates whether the occurrence is relative to the end of the specified week or month.
-
getOccurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month.
-
withOccurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
- Parameters:
occurrenceRelativeToEnd- Indicates whether the occurrence is relative to the end of the specified week or month.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isOccurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month.
-
setOccurrenceUnit
The unit for
occurrenceDaySet(DayOfWeekorDayOfMonth).- Parameters:
occurrenceUnit- The unit foroccurrenceDaySet(DayOfWeekorDayOfMonth).
-
getOccurrenceUnit
The unit for
occurrenceDaySet(DayOfWeekorDayOfMonth).- Returns:
- The unit for
occurrenceDaySet(DayOfWeekorDayOfMonth).
-
withOccurrenceUnit
The unit for
occurrenceDaySet(DayOfWeekorDayOfMonth).- Parameters:
occurrenceUnit- The unit foroccurrenceDaySet(DayOfWeekorDayOfMonth).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-