Package com.commercetools.api.models.order

Interface OrderChangeOrderStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderChangeOrderStateAction
extends OrderUpdateAction

Produces the Order State Changed Message.

Example to create an instance using the builder pattern

     OrderChangeOrderStateAction orderChangeOrderStateAction = OrderChangeOrderStateAction.builder()
             .orderState(OrderState.OPEN)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ORDER_STATE	discriminator value for OrderChangeOrderStateAction

Method Summary

Modifier and Type	Method	Description
static OrderChangeOrderStateActionBuilder	builder()	builder factory method for OrderChangeOrderStateAction
static OrderChangeOrderStateActionBuilder	builder(OrderChangeOrderStateAction template)	create builder for OrderChangeOrderStateAction instance
OrderChangeOrderStateAction	copyDeep()
static OrderChangeOrderStateAction	deepCopy(OrderChangeOrderStateAction template)	factory method to create a deep copy of OrderChangeOrderStateAction
@NotNull OrderState	getOrderState()	New status of the Order.
static OrderChangeOrderStateAction	of()	factory method
static OrderChangeOrderStateAction	of(OrderChangeOrderStateAction template)	factory method to create a shallow copy OrderChangeOrderStateAction
void	setOrderState(OrderState orderState)	New status of the Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderChangeOrderStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderChangeOrderStateAction(Function<OrderChangeOrderStateAction,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_ORDER_STATE

static final String CHANGE_ORDER_STATE

discriminator value for OrderChangeOrderStateAction

See Also:

• Constant Field Values

Method Details

getOrderState

@NotNull
@NotNull OrderState getOrderState()

New status of the Order.

Returns:

orderState

setOrderState

void setOrderState(OrderState orderState)

New status of the Order.

Parameters:

orderState - value to be set

of

static OrderChangeOrderStateAction of()

factory method

Returns:

instance of OrderChangeOrderStateAction

of

static OrderChangeOrderStateAction of(OrderChangeOrderStateAction template)

factory method to create a shallow copy OrderChangeOrderStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderChangeOrderStateAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderChangeOrderStateAction deepCopy(@Nullable
 OrderChangeOrderStateAction template)

factory method to create a deep copy of OrderChangeOrderStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderChangeOrderStateActionBuilder builder()

builder factory method for OrderChangeOrderStateAction

Returns:

builder

builder

static OrderChangeOrderStateActionBuilder builder(OrderChangeOrderStateAction template)

create builder for OrderChangeOrderStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderChangeOrderStateAction

default <T> T withOrderChangeOrderStateAction(Function<OrderChangeOrderStateAction,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<OrderChangeOrderStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference