Package com.commercetools.api.models.order

Interface OrderChangeShipmentStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderChangeShipmentStateAction
extends OrderUpdateAction

Produces the Order Shipment State Changed Message.

Example to create an instance using the builder pattern

     OrderChangeShipmentStateAction orderChangeShipmentStateAction = OrderChangeShipmentStateAction.builder()
             .shipmentState(ShipmentState.SHIPPED)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_SHIPMENT_STATE	discriminator value for OrderChangeShipmentStateAction

Method Summary

Modifier and Type	Method	Description
static OrderChangeShipmentStateActionBuilder	builder()	builder factory method for OrderChangeShipmentStateAction
static OrderChangeShipmentStateActionBuilder	builder(OrderChangeShipmentStateAction template)	create builder for OrderChangeShipmentStateAction instance
OrderChangeShipmentStateAction	copyDeep()
static OrderChangeShipmentStateAction	deepCopy(OrderChangeShipmentStateAction template)	factory method to create a deep copy of OrderChangeShipmentStateAction
@NotNull ShipmentState	getShipmentState()	New shipment status of the Order.
static OrderChangeShipmentStateAction	of()	factory method
static OrderChangeShipmentStateAction	of(OrderChangeShipmentStateAction template)	factory method to create a shallow copy OrderChangeShipmentStateAction
void	setShipmentState(ShipmentState shipmentState)	New shipment status of the Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderChangeShipmentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderChangeShipmentStateAction(Function<OrderChangeShipmentStateAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order.OrderUpdateAction

getAction, withOrderUpdateAction

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

get

Field Details

CHANGE_SHIPMENT_STATE

static final String CHANGE_SHIPMENT_STATE

discriminator value for OrderChangeShipmentStateAction

See Also:

• Constant Field Values

Method Details

getShipmentState

@NotNull
@NotNull ShipmentState getShipmentState()

New shipment status of the Order.

Returns:

shipmentState

setShipmentState

void setShipmentState(ShipmentState shipmentState)

New shipment status of the Order.

Parameters:

shipmentState - value to be set

of

static OrderChangeShipmentStateAction of()

factory method

Returns:

instance of OrderChangeShipmentStateAction

of

static OrderChangeShipmentStateAction of(OrderChangeShipmentStateAction template)

factory method to create a shallow copy OrderChangeShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderChangeShipmentStateAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderChangeShipmentStateAction deepCopy(@Nullable
 OrderChangeShipmentStateAction template)

factory method to create a deep copy of OrderChangeShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderChangeShipmentStateActionBuilder builder()

builder factory method for OrderChangeShipmentStateAction

Returns:

builder

builder

static OrderChangeShipmentStateActionBuilder builder(OrderChangeShipmentStateAction template)

create builder for OrderChangeShipmentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderChangeShipmentStateAction

default <T> T withOrderChangeShipmentStateAction(Function<OrderChangeShipmentStateAction,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<OrderChangeShipmentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference