Package com.commercetools.api.models.message

Interface OrderStateTransitionMessage

All Superinterfaces:

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

All Known Implementing Classes:

OrderStateTransitionMessageImpl

public interface OrderStateTransitionMessage
extends OrderMessage

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     OrderStateTransitionMessage orderStateTransitionMessage = OrderStateTransitionMessage.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	ORDER_STATE_TRANSITION	discriminator value for OrderStateTransitionMessage

Method Summary

Modifier and Type	Method	Description
static OrderStateTransitionMessageBuilder	builder()	builder factory method for OrderStateTransitionMessage
static OrderStateTransitionMessageBuilder	builder(OrderStateTransitionMessage template)	create builder for OrderStateTransitionMessage instance
static OrderStateTransitionMessage	deepCopy(OrderStateTransitionMessage template)	factory method to create a deep copy of OrderStateTransitionMessage
@NotNull Boolean	getForce()	Whether State transition validations were turned off during the Transition State update action.
@Valid StateReference	getOldState()	OrderState before the Transition State update action.
@NotNull @Valid StateReference	getState()	OrderState after the Transition State update action.
static OrderStateTransitionMessage	of()	factory method
static OrderStateTransitionMessage	of(OrderStateTransitionMessage template)	factory method to create a shallow copy OrderStateTransitionMessage
void	setForce(Boolean force)	Whether State transition validations were turned off during the Transition State update action.
void	setOldState(StateReference oldState)	OrderState before the Transition State update action.
void	setState(StateReference state)	OrderState after the Transition State update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderStateTransitionMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderStateTransitionMessage(Function<OrderStateTransitionMessage,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

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

withOrderMessage

Field Details

ORDER_STATE_TRANSITION

static final String ORDER_STATE_TRANSITION

discriminator value for OrderStateTransitionMessage

See Also:

• Constant Field Values

Method Details

getState

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

OrderState after the Transition State update action.

Returns:

state

getOldState

@Valid
@Valid StateReference getOldState()

OrderState 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)

OrderState after the Transition State update action.

Parameters:

state - value to be set

setOldState

void setOldState(StateReference oldState)

OrderState 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 OrderStateTransitionMessage of()

factory method

Returns:

instance of OrderStateTransitionMessage

of

static OrderStateTransitionMessage of(OrderStateTransitionMessage template)

factory method to create a shallow copy OrderStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderStateTransitionMessage deepCopy(@Nullable
 OrderStateTransitionMessage template)

factory method to create a deep copy of OrderStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderStateTransitionMessageBuilder builder()

builder factory method for OrderStateTransitionMessage

Returns:

builder

builder

static OrderStateTransitionMessageBuilder builder(OrderStateTransitionMessage template)

create builder for OrderStateTransitionMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderStateTransitionMessage

default <T> T withOrderStateTransitionMessage(Function<OrderStateTransitionMessage,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<OrderStateTransitionMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference