Package com.commercetools.api.models.message

Interface OrderStateChangedMessage

All Superinterfaces:

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

public interface OrderStateChangedMessage
extends OrderMessage

Generated after a successful Change OrderState update action.

Example to create an instance using the builder pattern

     OrderStateChangedMessage orderStateChangedMessage = OrderStateChangedMessage.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)
             .orderState(OrderState.OPEN)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_STATE_CHANGED	discriminator value for OrderStateChangedMessage

Method Summary

Modifier and Type	Method	Description
static OrderStateChangedMessageBuilder	builder()	builder factory method for OrderStateChangedMessage
static OrderStateChangedMessageBuilder	builder(OrderStateChangedMessage template)	create builder for OrderStateChangedMessage instance
OrderStateChangedMessage	copyDeep()
static OrderStateChangedMessage	deepCopy(OrderStateChangedMessage template)	factory method to create a deep copy of OrderStateChangedMessage
OrderState	getOldOrderState()	OrderState before the Change Order State update action.
@NotNull OrderState	getOrderState()	OrderState after the Change Order State update action.
static OrderStateChangedMessage	of()	factory method
static OrderStateChangedMessage	of(OrderStateChangedMessage template)	factory method to create a shallow copy OrderStateChangedMessage
void	setOldOrderState(OrderState oldOrderState)	OrderState before the Change Order State update action.
void	setOrderState(OrderState orderState)	OrderState after the Change Order State update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderStateChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderStateChangedMessage(Function<OrderStateChangedMessage,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_CHANGED

static final String ORDER_STATE_CHANGED

discriminator value for OrderStateChangedMessage

See Also:

• Constant Field Values

Method Details

getOrderState

@NotNull
@NotNull OrderState getOrderState()

OrderState after the Change Order State update action.

Returns:

orderState

getOldOrderState

OrderState getOldOrderState()

OrderState before the Change Order State update action.

Returns:

oldOrderState

setOrderState

void setOrderState(OrderState orderState)

OrderState after the Change Order State update action.

Parameters:

orderState - value to be set

setOldOrderState

void setOldOrderState(OrderState oldOrderState)

OrderState before the Change Order State update action.

Parameters:

oldOrderState - value to be set

of

static OrderStateChangedMessage of()

factory method

Returns:

instance of OrderStateChangedMessage

of

static OrderStateChangedMessage of(OrderStateChangedMessage template)

factory method to create a shallow copy OrderStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderStateChangedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static OrderStateChangedMessage deepCopy(@Nullable
 OrderStateChangedMessage template)

factory method to create a deep copy of OrderStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderStateChangedMessageBuilder builder()

builder factory method for OrderStateChangedMessage

Returns:

builder

builder

static OrderStateChangedMessageBuilder builder(OrderStateChangedMessage template)

create builder for OrderStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderStateChangedMessage

default <T> T withOrderStateChangedMessage(Function<OrderStateChangedMessage,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<OrderStateChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference