Package com.commercetools.api.models.message

Interface OrderPaymentStateChangedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

All Known Implementing Classes:

OrderPaymentStateChangedMessageImpl

public interface OrderPaymentStateChangedMessage
extends OrderMessage

Generated after a successful Change PaymentState update action.

Example to create an instance using the builder pattern

     OrderPaymentStateChangedMessage orderPaymentStateChangedMessage = OrderPaymentStateChangedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .paymentState(PaymentState.BALANCE_DUE)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderPaymentStateChangedMessageBuilder	builder()	builder factory method for OrderPaymentStateChangedMessage
static OrderPaymentStateChangedMessageBuilder	builder(OrderPaymentStateChangedMessage template)	create builder for OrderPaymentStateChangedMessage instance
static OrderPaymentStateChangedMessage	deepCopy(OrderPaymentStateChangedMessage template)	factory method to create a deep copy of OrderPaymentStateChangedMessage
PaymentState	getOldPaymentState()	PaymentState before the Change Payment State update action.
@NotNull PaymentState	getPaymentState()	PaymentState after the Change Payment State update action.
static OrderPaymentStateChangedMessage	of()	factory method
static OrderPaymentStateChangedMessage	of(OrderPaymentStateChangedMessage template)	factory method to create a shallow copy OrderPaymentStateChangedMessage
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<OrderPaymentStateChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPaymentStateChangedMessage(Function<OrderPaymentStateChangedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

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

withOrderMessage

Field Details

ORDER_PAYMENT_STATE_CHANGED

static final String ORDER_PAYMENT_STATE_CHANGED

discriminator value for OrderPaymentStateChangedMessage

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

factory method

Returns:

instance of OrderPaymentStateChangedMessage

of

static OrderPaymentStateChangedMessage of(OrderPaymentStateChangedMessage template)

factory method to create a shallow copy OrderPaymentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderPaymentStateChangedMessage deepCopy(@Nullable
 OrderPaymentStateChangedMessage template)

factory method to create a deep copy of OrderPaymentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPaymentStateChangedMessageBuilder builder()

builder factory method for OrderPaymentStateChangedMessage

Returns:

builder

builder

static OrderPaymentStateChangedMessageBuilder builder(OrderPaymentStateChangedMessage template)

create builder for OrderPaymentStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPaymentStateChangedMessage

default <T> T withOrderPaymentStateChangedMessage(Function<OrderPaymentStateChangedMessage,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<OrderPaymentStateChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference