Package com.commercetools.api.models.order_edit

Interface StagedOrderChangeShipmentStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderChangeShipmentStateActionImpl

public interface StagedOrderChangeShipmentStateAction
extends StagedOrderUpdateAction

Produces the Order Shipment State Changed Message.

Example to create an instance using the builder pattern

     StagedOrderChangeShipmentStateAction stagedOrderChangeShipmentStateAction = StagedOrderChangeShipmentStateAction.builder()
             .shipmentState(ShipmentState.SHIPPED)
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

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

getAction, withStagedOrderUpdateAction

Field Details

CHANGE_SHIPMENT_STATE

static final String CHANGE_SHIPMENT_STATE

discriminator value for StagedOrderChangeShipmentStateAction

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

factory method

Returns:

instance of StagedOrderChangeShipmentStateAction

of

static StagedOrderChangeShipmentStateAction of(StagedOrderChangeShipmentStateAction template)

factory method to create a shallow copy StagedOrderChangeShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderChangeShipmentStateAction deepCopy(@Nullable
 StagedOrderChangeShipmentStateAction template)

factory method to create a deep copy of StagedOrderChangeShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderChangeShipmentStateActionBuilder builder()

builder factory method for StagedOrderChangeShipmentStateAction

Returns:

builder

builder

static StagedOrderChangeShipmentStateActionBuilder builder(StagedOrderChangeShipmentStateAction template)

create builder for StagedOrderChangeShipmentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderChangeShipmentStateAction

default <T> T withStagedOrderChangeShipmentStateAction(Function<StagedOrderChangeShipmentStateAction,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<StagedOrderChangeShipmentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference