Package com.commercetools.api.models.recurring_order

Interface RecurringOrderSetScheduleAction

All Superinterfaces:

RecurringOrderUpdateAction

public interface RecurringOrderSetScheduleAction
extends RecurringOrderUpdateAction

To set the schedule, the Recurring Order must be active, with no active Skip Configuration and with available prices for all Cart items for the new schedule. Setting the schedule generates the RecurringOrderScheduleSet Message.

Example to create an instance using the builder pattern

     RecurringOrderSetScheduleAction recurringOrderSetScheduleAction = RecurringOrderSetScheduleAction.builder()
             .recurrencePolicy(recurrencePolicyBuilder -> recurrencePolicyBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SCHEDULE	discriminator value for RecurringOrderSetScheduleAction

Method Summary

Modifier and Type	Method	Description
static RecurringOrderSetScheduleActionBuilder	builder()	builder factory method for RecurringOrderSetScheduleAction
static RecurringOrderSetScheduleActionBuilder	builder(RecurringOrderSetScheduleAction template)	create builder for RecurringOrderSetScheduleAction instance
RecurringOrderSetScheduleAction	copyDeep()
static RecurringOrderSetScheduleAction	deepCopy(RecurringOrderSetScheduleAction template)	factory method to create a deep copy of RecurringOrderSetScheduleAction
@NotNull @Valid RecurrencePolicyResourceIdentifier	getRecurrencePolicy()	Value to set.
static RecurringOrderSetScheduleAction	of()	factory method
static RecurringOrderSetScheduleAction	of(RecurringOrderSetScheduleAction template)	factory method to create a shallow copy RecurringOrderSetScheduleAction
void	setRecurrencePolicy(RecurrencePolicyResourceIdentifier recurrencePolicy)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderSetScheduleAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderSetScheduleAction(Function<RecurringOrderSetScheduleAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.recurring_order.RecurringOrderUpdateAction

getAction, withRecurringOrderUpdateAction

Field Details

SET_SCHEDULE

static final String SET_SCHEDULE

discriminator value for RecurringOrderSetScheduleAction

See Also:

• Constant Field Values

Method Details

getRecurrencePolicy

@NotNull
@Valid
@NotNull @Valid RecurrencePolicyResourceIdentifier getRecurrencePolicy()

Value to set.

Returns:

recurrencePolicy

setRecurrencePolicy

void setRecurrencePolicy(RecurrencePolicyResourceIdentifier recurrencePolicy)

Value to set.

Parameters:

recurrencePolicy - value to be set

of

static RecurringOrderSetScheduleAction of()

factory method

Returns:

instance of RecurringOrderSetScheduleAction

of

static RecurringOrderSetScheduleAction of(RecurringOrderSetScheduleAction template)

factory method to create a shallow copy RecurringOrderSetScheduleAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderSetScheduleAction copyDeep()

Specified by:

copyDeep in interface RecurringOrderUpdateAction

deepCopy

@Nullable
static RecurringOrderSetScheduleAction deepCopy(@Nullable
 RecurringOrderSetScheduleAction template)

factory method to create a deep copy of RecurringOrderSetScheduleAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderSetScheduleActionBuilder builder()

builder factory method for RecurringOrderSetScheduleAction

Returns:

builder

builder

static RecurringOrderSetScheduleActionBuilder builder(RecurringOrderSetScheduleAction template)

create builder for RecurringOrderSetScheduleAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderSetScheduleAction

default <T> T withRecurringOrderSetScheduleAction(Function<RecurringOrderSetScheduleAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderSetScheduleAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference