Package com.commercetools.api.models.message

Interface OrderShipmentStateChangedMessage

All Superinterfaces:

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

All Known Implementing Classes:

OrderShipmentStateChangedMessageImpl

public interface OrderShipmentStateChangedMessage
extends OrderMessage

Generated after a successful Change ShipmentState update action.

Example to create an instance using the builder pattern

     OrderShipmentStateChangedMessage orderShipmentStateChangedMessage = OrderShipmentStateChangedMessage.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)
             .shipmentState(ShipmentState.SHIPPED)
             .oldShipmentState(ShipmentState.SHIPPED)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_SHIPMENT_STATE_CHANGED	discriminator value for OrderShipmentStateChangedMessage

Method Summary

Modifier and Type	Method	Description
static OrderShipmentStateChangedMessageBuilder	builder()	builder factory method for OrderShipmentStateChangedMessage
static OrderShipmentStateChangedMessageBuilder	builder(OrderShipmentStateChangedMessage template)	create builder for OrderShipmentStateChangedMessage instance
static OrderShipmentStateChangedMessage	deepCopy(OrderShipmentStateChangedMessage template)	factory method to create a deep copy of OrderShipmentStateChangedMessage
@NotNull ShipmentState	getOldShipmentState()	ShipmentState before the Change Shipment State update action.
@NotNull ShipmentState	getShipmentState()	ShipmentState after the Change Shipment State update action.
static OrderShipmentStateChangedMessage	of()	factory method
static OrderShipmentStateChangedMessage	of(OrderShipmentStateChangedMessage template)	factory method to create a shallow copy OrderShipmentStateChangedMessage
void	setOldShipmentState(ShipmentState oldShipmentState)	ShipmentState before the Change Shipment State update action.
void	setShipmentState(ShipmentState shipmentState)	ShipmentState after the Change Shipment State update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderShipmentStateChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShipmentStateChangedMessage(Function<OrderShipmentStateChangedMessage,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_SHIPMENT_STATE_CHANGED

static final String ORDER_SHIPMENT_STATE_CHANGED

discriminator value for OrderShipmentStateChangedMessage

See Also:

• Constant Field Values

Method Details

getShipmentState

@NotNull
@NotNull ShipmentState getShipmentState()

ShipmentState after the Change Shipment State update action.

Returns:

shipmentState

getOldShipmentState

@NotNull
@NotNull ShipmentState getOldShipmentState()

ShipmentState before the Change Shipment State update action.

Returns:

oldShipmentState

setShipmentState

void setShipmentState(ShipmentState shipmentState)

ShipmentState after the Change Shipment State update action.

Parameters:

shipmentState - value to be set

setOldShipmentState

void setOldShipmentState(ShipmentState oldShipmentState)

ShipmentState before the Change Shipment State update action.

Parameters:

oldShipmentState - value to be set

of

static OrderShipmentStateChangedMessage of()

factory method

Returns:

instance of OrderShipmentStateChangedMessage

of

static OrderShipmentStateChangedMessage of(OrderShipmentStateChangedMessage template)

factory method to create a shallow copy OrderShipmentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderShipmentStateChangedMessage deepCopy(@Nullable
 OrderShipmentStateChangedMessage template)

factory method to create a deep copy of OrderShipmentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShipmentStateChangedMessageBuilder builder()

builder factory method for OrderShipmentStateChangedMessage

Returns:

builder

builder

static OrderShipmentStateChangedMessageBuilder builder(OrderShipmentStateChangedMessage template)

create builder for OrderShipmentStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShipmentStateChangedMessage

default <T> T withOrderShipmentStateChangedMessage(Function<OrderShipmentStateChangedMessage,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<OrderShipmentStateChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference