Class ScheduledInstanceRecurrenceRequest
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the recurring schedule for a Scheduled Instance.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The 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 forOccurrenceDays
(DayOfWeek
orDayOfMonth
).int
hashCode()
Indicates whether the occurrence is relative to the end of the specified week or month.void
setFrequency
(String frequency) The frequency (Daily
,Weekly
, orMonthly
).void
setInterval
(Integer interval) The interval quantity.void
setOccurrenceDays
(Collection<Integer> occurrenceDays) The days.void
setOccurrenceRelativeToEnd
(Boolean occurrenceRelativeToEnd) Indicates whether the occurrence is relative to the end of the specified week or month.void
setOccurrenceUnit
(String occurrenceUnit) The unit forOccurrenceDays
(DayOfWeek
orDayOfMonth
).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.withOccurrenceDays
(Integer... occurrenceDays) The days.withOccurrenceDays
(Collection<Integer> occurrenceDays) 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 forOccurrenceDays
(DayOfWeek
orDayOfMonth
).
-
Constructor Details
-
ScheduledInstanceRecurrenceRequest
public ScheduledInstanceRecurrenceRequest()
-
-
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.
-
getOccurrenceDays
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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- 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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
-
setOccurrenceDays
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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- Parameters:
occurrenceDays
- 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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
-
withOccurrenceDays
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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
NOTE: This method appends the values to the existing list (if any). Use
setOccurrenceDays(java.util.Collection)
orwithOccurrenceDays(java.util.Collection)
if you want to override the existing values.- Parameters:
occurrenceDays
- 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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withOccurrenceDays
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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- Parameters:
occurrenceDays
- 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). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.- 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. You can't specify this value with a daily schedule.
- Parameters:
occurrenceRelativeToEnd
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
getOccurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
withOccurrenceRelativeToEnd
public ScheduledInstanceRecurrenceRequest withOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd) Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Parameters:
occurrenceRelativeToEnd
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.- 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. You can't specify this value with a daily schedule.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
setOccurrenceUnit
The unit for
OccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.- Parameters:
occurrenceUnit
- The unit forOccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.
-
getOccurrenceUnit
The unit for
OccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.- Returns:
- The unit for
OccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.
-
withOccurrenceUnit
The unit for
OccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.- Parameters:
occurrenceUnit
- The unit forOccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.- 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
-