Package com.commercetools.api.models.message

Interface OrderPaymentStateChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderPaymentStateChangedMessagePayload
extends OrderMessagePayload

Generated after a successful Change PaymentState update action.

Example to create an instance using the builder pattern

     OrderPaymentStateChangedMessagePayload orderPaymentStateChangedMessagePayload = OrderPaymentStateChangedMessagePayload.builder()
             .paymentState(PaymentState.BALANCE_DUE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_PAYMENT_STATE_CHANGED	discriminator value for OrderPaymentStateChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderPaymentStateChangedMessagePayloadBuilder	builder()	builder factory method for OrderPaymentStateChangedMessagePayload
static OrderPaymentStateChangedMessagePayloadBuilder	builder(OrderPaymentStateChangedMessagePayload template)	create builder for OrderPaymentStateChangedMessagePayload instance
OrderPaymentStateChangedMessagePayload	copyDeep()
static OrderPaymentStateChangedMessagePayload	deepCopy(OrderPaymentStateChangedMessagePayload template)	factory method to create a deep copy of OrderPaymentStateChangedMessagePayload
PaymentState	getOldPaymentState()	PaymentState before the Change Payment State update action.
@NotNull PaymentState	getPaymentState()	PaymentState after the Change Payment State update action.
static OrderPaymentStateChangedMessagePayload	of()	factory method
static OrderPaymentStateChangedMessagePayload	of(OrderPaymentStateChangedMessagePayload template)	factory method to create a shallow copy OrderPaymentStateChangedMessagePayload
void	setOldPaymentState(PaymentState oldPaymentState)	PaymentState before the Change Payment State update action.
void	setPaymentState(PaymentState paymentState)	PaymentState after the Change Payment State update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderPaymentStateChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPaymentStateChangedMessagePayload(Function<OrderPaymentStateChangedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Methods inherited from interface com.commercetools.api.models.message.OrderMessagePayload

withOrderMessagePayload

Field Details

ORDER_PAYMENT_STATE_CHANGED

static final String ORDER_PAYMENT_STATE_CHANGED

discriminator value for OrderPaymentStateChangedMessagePayload

See Also:

• Constant Field Values

Method Details

getPaymentState

@NotNull
@NotNull PaymentState getPaymentState()

PaymentState after the Change Payment State update action.

Returns:

paymentState

getOldPaymentState

PaymentState getOldPaymentState()

PaymentState before the Change Payment State update action.

Returns:

oldPaymentState

setPaymentState

void setPaymentState(PaymentState paymentState)

PaymentState after the Change Payment State update action.

Parameters:

paymentState - value to be set

setOldPaymentState

void setOldPaymentState(PaymentState oldPaymentState)

PaymentState before the Change Payment State update action.

Parameters:

oldPaymentState - value to be set

of

static OrderPaymentStateChangedMessagePayload of()

factory method

Returns:

instance of OrderPaymentStateChangedMessagePayload

of

static OrderPaymentStateChangedMessagePayload of(OrderPaymentStateChangedMessagePayload template)

factory method to create a shallow copy OrderPaymentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderPaymentStateChangedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderPaymentStateChangedMessagePayload deepCopy(@Nullable
 OrderPaymentStateChangedMessagePayload template)

factory method to create a deep copy of OrderPaymentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPaymentStateChangedMessagePayloadBuilder builder()

builder factory method for OrderPaymentStateChangedMessagePayload

Returns:

builder

builder

static OrderPaymentStateChangedMessagePayloadBuilder builder(OrderPaymentStateChangedMessagePayload template)

create builder for OrderPaymentStateChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPaymentStateChangedMessagePayload

default <T> T withOrderPaymentStateChangedMessagePayload(Function<OrderPaymentStateChangedMessagePayload,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<OrderPaymentStateChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference