Package com.commercetools.api.models.order

Interface OrderChangePaymentStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderChangePaymentStateAction
extends OrderUpdateAction

Produces the Order Payment State Changed Message.

Example to create an instance using the builder pattern

     OrderChangePaymentStateAction orderChangePaymentStateAction = OrderChangePaymentStateAction.builder()
             .paymentState(PaymentState.BALANCE_DUE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_PAYMENT_STATE	discriminator value for OrderChangePaymentStateAction

Method Summary

Modifier and Type	Method	Description
static OrderChangePaymentStateActionBuilder	builder()	builder factory method for OrderChangePaymentStateAction
static OrderChangePaymentStateActionBuilder	builder(OrderChangePaymentStateAction template)	create builder for OrderChangePaymentStateAction instance
OrderChangePaymentStateAction	copyDeep()
static OrderChangePaymentStateAction	deepCopy(OrderChangePaymentStateAction template)	factory method to create a deep copy of OrderChangePaymentStateAction
@NotNull PaymentState	getPaymentState()	New payment status of the Order.
static OrderChangePaymentStateAction	of()	factory method
static OrderChangePaymentStateAction	of(OrderChangePaymentStateAction template)	factory method to create a shallow copy OrderChangePaymentStateAction
void	setPaymentState(PaymentState paymentState)	New payment status of the Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderChangePaymentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderChangePaymentStateAction(Function<OrderChangePaymentStateAction,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_PAYMENT_STATE

static final String CHANGE_PAYMENT_STATE

discriminator value for OrderChangePaymentStateAction

See Also:

• Constant Field Values

Method Details

getPaymentState

@NotNull
@NotNull PaymentState getPaymentState()

New payment status of the Order.

Returns:

paymentState

setPaymentState

void setPaymentState(PaymentState paymentState)

New payment status of the Order.

Parameters:

paymentState - value to be set

of

static OrderChangePaymentStateAction of()

factory method

Returns:

instance of OrderChangePaymentStateAction

of

static OrderChangePaymentStateAction of(OrderChangePaymentStateAction template)

factory method to create a shallow copy OrderChangePaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderChangePaymentStateAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderChangePaymentStateAction deepCopy(@Nullable
 OrderChangePaymentStateAction template)

factory method to create a deep copy of OrderChangePaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderChangePaymentStateActionBuilder builder()

builder factory method for OrderChangePaymentStateAction

Returns:

builder

builder

static OrderChangePaymentStateActionBuilder builder(OrderChangePaymentStateAction template)

create builder for OrderChangePaymentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderChangePaymentStateAction

default <T> T withOrderChangePaymentStateAction(Function<OrderChangePaymentStateAction,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<OrderChangePaymentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference