Package com.commercetools.api.models.message

Interface OrderShipmentStateChangedMessagePayload

All Superinterfaces:

MessagePayload, OrderMessagePayload

All Known Implementing Classes:

OrderShipmentStateChangedMessagePayloadImpl

public interface OrderShipmentStateChangedMessagePayload
extends OrderMessagePayload

Generated after a successful Change ShipmentState update action.

Example to create an instance using the builder pattern

     OrderShipmentStateChangedMessagePayload orderShipmentStateChangedMessagePayload = OrderShipmentStateChangedMessagePayload.builder()
             .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 OrderShipmentStateChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderShipmentStateChangedMessagePayloadBuilder	builder()	builder factory method for OrderShipmentStateChangedMessagePayload
static OrderShipmentStateChangedMessagePayloadBuilder	builder(OrderShipmentStateChangedMessagePayload template)	create builder for OrderShipmentStateChangedMessagePayload instance
static OrderShipmentStateChangedMessagePayload	deepCopy(OrderShipmentStateChangedMessagePayload template)	factory method to create a deep copy of OrderShipmentStateChangedMessagePayload
@NotNull ShipmentState	getOldShipmentState()	ShipmentState before the Change Shipment State update action.
@NotNull ShipmentState	getShipmentState()	ShipmentState after the Change Shipment State update action.
static OrderShipmentStateChangedMessagePayload	of()	factory method
static OrderShipmentStateChangedMessagePayload	of(OrderShipmentStateChangedMessagePayload template)	factory method to create a shallow copy OrderShipmentStateChangedMessagePayload
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<OrderShipmentStateChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShipmentStateChangedMessagePayload(Function<OrderShipmentStateChangedMessagePayload,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.OrderMessagePayload

withOrderMessagePayload

Field Details

ORDER_SHIPMENT_STATE_CHANGED

static final String ORDER_SHIPMENT_STATE_CHANGED

discriminator value for OrderShipmentStateChangedMessagePayload

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

factory method

Returns:

instance of OrderShipmentStateChangedMessagePayload

of

static OrderShipmentStateChangedMessagePayload of(OrderShipmentStateChangedMessagePayload template)

factory method to create a shallow copy OrderShipmentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderShipmentStateChangedMessagePayload deepCopy(@Nullable
 OrderShipmentStateChangedMessagePayload template)

factory method to create a deep copy of OrderShipmentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShipmentStateChangedMessagePayloadBuilder builder()

builder factory method for OrderShipmentStateChangedMessagePayload

Returns:

builder

builder

static OrderShipmentStateChangedMessagePayloadBuilder builder(OrderShipmentStateChangedMessagePayload template)

create builder for OrderShipmentStateChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShipmentStateChangedMessagePayload

default <T> T withOrderShipmentStateChangedMessagePayload(Function<OrderShipmentStateChangedMessagePayload,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<OrderShipmentStateChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference