Package com.commercetools.api.models.message

Interface RecurringOrderStateTransitionMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface RecurringOrderStateTransitionMessage
extends Message

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     RecurringOrderStateTransitionMessage recurringOrderStateTransitionMessage = RecurringOrderStateTransitionMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RecurringOrderStateTransitionMessageBuilder	builder()	builder factory method for RecurringOrderStateTransitionMessage
static RecurringOrderStateTransitionMessageBuilder	builder(RecurringOrderStateTransitionMessage template)	create builder for RecurringOrderStateTransitionMessage instance
RecurringOrderStateTransitionMessage	copyDeep()
static RecurringOrderStateTransitionMessage	deepCopy(RecurringOrderStateTransitionMessage template)	factory method to create a deep copy of RecurringOrderStateTransitionMessage
@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 RecurringOrderStateTransitionMessage	of()	factory method
static RecurringOrderStateTransitionMessage	of(RecurringOrderStateTransitionMessage template)	factory method to create a shallow copy RecurringOrderStateTransitionMessage
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<RecurringOrderStateTransitionMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRecurringOrderStateTransitionMessage(Function<RecurringOrderStateTransitionMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

RECURRING_ORDER_STATE_TRANSITION

static final String RECURRING_ORDER_STATE_TRANSITION

discriminator value for RecurringOrderStateTransitionMessage

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 RecurringOrderStateTransitionMessage of()

factory method

Returns:

instance of RecurringOrderStateTransitionMessage

of

static RecurringOrderStateTransitionMessage of(RecurringOrderStateTransitionMessage template)

factory method to create a shallow copy RecurringOrderStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderStateTransitionMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static RecurringOrderStateTransitionMessage deepCopy(@Nullable
 RecurringOrderStateTransitionMessage template)

factory method to create a deep copy of RecurringOrderStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderStateTransitionMessageBuilder builder()

builder factory method for RecurringOrderStateTransitionMessage

Returns:

builder

builder

static RecurringOrderStateTransitionMessageBuilder builder(RecurringOrderStateTransitionMessage template)

create builder for RecurringOrderStateTransitionMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderStateTransitionMessage

default <T> T withRecurringOrderStateTransitionMessage(Function<RecurringOrderStateTransitionMessage,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<RecurringOrderStateTransitionMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference