Package com.commercetools.api.models.recurring_order

Interface RecurringOrderTransitionStateAction

All Superinterfaces:

RecurringOrderUpdateAction

public interface RecurringOrderTransitionStateAction
extends RecurringOrderUpdateAction

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed.

This update action produces the Recurring Order State Transition Message.

Example to create an instance using the builder pattern

     RecurringOrderTransitionStateAction recurringOrderTransitionStateAction = RecurringOrderTransitionStateAction.builder()
             .state(stateBuilder -> stateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSITION_STATE	discriminator value for RecurringOrderTransitionStateAction

Method Summary

Modifier and Type	Method	Description
static RecurringOrderTransitionStateActionBuilder	builder()	builder factory method for RecurringOrderTransitionStateAction
static RecurringOrderTransitionStateActionBuilder	builder(RecurringOrderTransitionStateAction template)	create builder for RecurringOrderTransitionStateAction instance
RecurringOrderTransitionStateAction	copyDeep()
static RecurringOrderTransitionStateAction	deepCopy(RecurringOrderTransitionStateAction template)	factory method to create a deep copy of RecurringOrderTransitionStateAction
Boolean	getForce()	Set to true to turn off validation.
@NotNull @Valid StateResourceIdentifier	getState()	Value to set.
static RecurringOrderTransitionStateAction	of()	factory method
static RecurringOrderTransitionStateAction	of(RecurringOrderTransitionStateAction template)	factory method to create a shallow copy RecurringOrderTransitionStateAction
void	setForce(Boolean force)	Set to true to turn off validation.
void	setState(StateResourceIdentifier state)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderTransitionStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderTransitionStateAction(Function<RecurringOrderTransitionStateAction,T> helper)	accessor map function

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

getAction, withRecurringOrderUpdateAction

Field Details

TRANSITION_STATE

static final String TRANSITION_STATE

discriminator value for RecurringOrderTransitionStateAction

See Also:

• Constant Field Values

Method Details

getState

@NotNull
@Valid
@NotNull @Valid StateResourceIdentifier getState()

Value to set. If there is no State yet, the new State must be an initial State.

Returns:

state

getForce

Boolean getForce()

Set to true to turn off validation.

Returns:

force

setState

void setState(StateResourceIdentifier state)

Value to set. If there is no State yet, the new State must be an initial State.

Parameters:

state - value to be set

setForce

void setForce(Boolean force)

Set to true to turn off validation.

Parameters:

force - value to be set

of

static RecurringOrderTransitionStateAction of()

factory method

Returns:

instance of RecurringOrderTransitionStateAction

of

static RecurringOrderTransitionStateAction of(RecurringOrderTransitionStateAction template)

factory method to create a shallow copy RecurringOrderTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderTransitionStateAction copyDeep()

Specified by:

copyDeep in interface RecurringOrderUpdateAction

deepCopy

@Nullable
static RecurringOrderTransitionStateAction deepCopy(@Nullable
 RecurringOrderTransitionStateAction template)

factory method to create a deep copy of RecurringOrderTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderTransitionStateActionBuilder builder()

builder factory method for RecurringOrderTransitionStateAction

Returns:

builder

builder

static RecurringOrderTransitionStateActionBuilder builder(RecurringOrderTransitionStateAction template)

create builder for RecurringOrderTransitionStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderTransitionStateAction

default <T> T withRecurringOrderTransitionStateAction(Function<RecurringOrderTransitionStateAction,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<RecurringOrderTransitionStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference