Package com.commercetools.api.models.message

Interface RecurringOrderStateTransitionMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface RecurringOrderStateTransitionMessagePayload
extends MessagePayload

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     RecurringOrderStateTransitionMessagePayload recurringOrderStateTransitionMessagePayload = RecurringOrderStateTransitionMessagePayload.builder()
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECURRING_ORDER_STATE_TRANSITION	discriminator value for RecurringOrderStateTransitionMessagePayload

Method Summary

Modifier and Type	Method	Description
static RecurringOrderStateTransitionMessagePayloadBuilder	builder()	builder factory method for RecurringOrderStateTransitionMessagePayload
static RecurringOrderStateTransitionMessagePayloadBuilder	builder(RecurringOrderStateTransitionMessagePayload template)	create builder for RecurringOrderStateTransitionMessagePayload instance
RecurringOrderStateTransitionMessagePayload	copyDeep()
static RecurringOrderStateTransitionMessagePayload	deepCopy(RecurringOrderStateTransitionMessagePayload template)	factory method to create a deep copy of RecurringOrderStateTransitionMessagePayload
@NotNull Boolean	getForce()	Whether State transition validations were turned off during the Transition State update action.
@Valid StateReference	getOldState()	RecurringOrderState before the Transition State update action.
@NotNull @Valid StateReference	getState()	RecurringOrderState after the Transition State update action.
static RecurringOrderStateTransitionMessagePayload	of()	factory method
static RecurringOrderStateTransitionMessagePayload	of(RecurringOrderStateTransitionMessagePayload template)	factory method to create a shallow copy RecurringOrderStateTransitionMessagePayload
void	setForce(Boolean force)	Whether State transition validations were turned off during the Transition State update action.
void	setOldState(StateReference oldState)	RecurringOrderState before the Transition State update action.
void	setState(StateReference state)	RecurringOrderState after the Transition State update action.
static com.fasterxml.jackson.core.type.TypeReference<RecurringOrderStateTransitionMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderStateTransitionMessagePayload(Function<RecurringOrderStateTransitionMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

RECURRING_ORDER_STATE_TRANSITION

static final String RECURRING_ORDER_STATE_TRANSITION

discriminator value for RecurringOrderStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getState

@NotNull
@Valid
@NotNull @Valid StateReference getState()

RecurringOrderState after the Transition State update action.

Returns:

state

getOldState

@Valid
@Valid StateReference getOldState()

RecurringOrderState before the Transition State update action.

Returns:

oldState

getForce

@NotNull
@NotNull Boolean getForce()

Whether State transition validations were turned off during the Transition State update action.

Returns:

force

setState

void setState(StateReference state)

RecurringOrderState after the Transition State update action.

Parameters:

state - value to be set

setOldState

void setOldState(StateReference oldState)

RecurringOrderState before the Transition State update action.

Parameters:

oldState - value to be set

setForce

void setForce(Boolean force)

Whether State transition validations were turned off during the Transition State update action.

Parameters:

force - value to be set

of

static RecurringOrderStateTransitionMessagePayload of()

factory method

Returns:

instance of RecurringOrderStateTransitionMessagePayload

of

static RecurringOrderStateTransitionMessagePayload of(RecurringOrderStateTransitionMessagePayload template)

factory method to create a shallow copy RecurringOrderStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderStateTransitionMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static RecurringOrderStateTransitionMessagePayload deepCopy(@Nullable
 RecurringOrderStateTransitionMessagePayload template)

factory method to create a deep copy of RecurringOrderStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderStateTransitionMessagePayloadBuilder builder()

builder factory method for RecurringOrderStateTransitionMessagePayload

Returns:

builder

builder

static RecurringOrderStateTransitionMessagePayloadBuilder builder(RecurringOrderStateTransitionMessagePayload template)

create builder for RecurringOrderStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderStateTransitionMessagePayload

default <T> T withRecurringOrderStateTransitionMessagePayload(Function<RecurringOrderStateTransitionMessagePayload,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<RecurringOrderStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference