Package com.commercetools.api.models.order_edit

Interface StagedOrderChangePaymentStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderChangePaymentStateActionImpl

public interface StagedOrderChangePaymentStateAction
extends StagedOrderUpdateAction

Produces the Order Payment State Changed Message.

Example to create an instance using the builder pattern

     StagedOrderChangePaymentStateAction stagedOrderChangePaymentStateAction = StagedOrderChangePaymentStateAction.builder()
             .paymentState(PaymentState.BALANCE_DUE)
             .build()
 

Field Summary

Fields

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

Method Summary

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

static final String CHANGE_PAYMENT_STATE

discriminator value for StagedOrderChangePaymentStateAction

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

factory method

Returns:

instance of StagedOrderChangePaymentStateAction

of

static StagedOrderChangePaymentStateAction of(StagedOrderChangePaymentStateAction template)

factory method to create a shallow copy StagedOrderChangePaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderChangePaymentStateAction deepCopy(@Nullable
 StagedOrderChangePaymentStateAction template)

factory method to create a deep copy of StagedOrderChangePaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderChangePaymentStateActionBuilder builder()

builder factory method for StagedOrderChangePaymentStateAction

Returns:

builder

builder

static StagedOrderChangePaymentStateActionBuilder builder(StagedOrderChangePaymentStateAction template)

create builder for StagedOrderChangePaymentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderChangePaymentStateAction

default <T> T withStagedOrderChangePaymentStateAction(Function<StagedOrderChangePaymentStateAction,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<StagedOrderChangePaymentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference