Interface DayOfMonthScheduleDraft
- All Superinterfaces:
Draft<DayOfMonthScheduleDraft>
,RecurrencePolicyScheduleDraft
public interface DayOfMonthScheduleDraft
extends RecurrencePolicyScheduleDraft, Draft<DayOfMonthScheduleDraft>
Determines the schedule for a Recurring Order to occur on a specific day of each month.
- Orders will be created even if the specified day is a weekend or holiday.
- To place orders on different dates within the same month (for example, the 1st and 15th), create separate Recurring Orders—each with its own schedule.
Example to create an instance using the builder pattern
DayOfMonthScheduleDraft dayOfMonthScheduleDraft = DayOfMonthScheduleDraft.builder()
.day(1)
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for DayOfMonthScheduleDraft -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for DayOfMonthScheduleDraftbuilder
(DayOfMonthScheduleDraft template) create builder for DayOfMonthScheduleDraft instancecopyDeep()
static DayOfMonthScheduleDraft
deepCopy
(DayOfMonthScheduleDraft template) factory method to create a deep copy of DayOfMonthScheduleDraft@NotNull Integer
getDay()
The day of the month when the Recurring Order should be created.static DayOfMonthScheduleDraft
of()
factory methodstatic DayOfMonthScheduleDraft
of
(DayOfMonthScheduleDraft template) factory method to create a shallow copy DayOfMonthScheduleDraftvoid
The day of the month when the Recurring Order should be created.static com.fasterxml.jackson.core.type.TypeReference<DayOfMonthScheduleDraft>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.recurrence_policy.RecurrencePolicyScheduleDraft
getType, withRecurrencePolicyScheduleDraft
-
Field Details
-
DAY_OF_MONTH
discriminator value for DayOfMonthScheduleDraft- See Also:
-
-
Method Details
-
getDay
The day of the month when the Recurring Order should be created. If the value is greater than the number of days in a given month, the order will be created on the last day of the month.
- Returns:
- day
-
setDay
The day of the month when the Recurring Order should be created. If the value is greater than the number of days in a given month, the order will be created on the last day of the month.
- Parameters:
day
- value to be set
-
of
factory method- Returns:
- instance of DayOfMonthScheduleDraft
-
of
factory method to create a shallow copy DayOfMonthScheduleDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
DayOfMonthScheduleDraft copyDeep()- Specified by:
copyDeep
in interfaceRecurrencePolicyScheduleDraft
-
deepCopy
factory method to create a deep copy of DayOfMonthScheduleDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for DayOfMonthScheduleDraft- Returns:
- builder
-
builder
create builder for DayOfMonthScheduleDraft instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withDayOfMonthScheduleDraft
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-