Package com.commercetools.api.models.message

Interface OrderPaymentAddedMessage

All Superinterfaces:

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

All Known Implementing Classes:

OrderPaymentAddedMessageImpl

public interface OrderPaymentAddedMessage
extends Message

Generated after a successful Add Payment update action or when a Payment is added via Order Edits.

Example to create an instance using the builder pattern

     OrderPaymentAddedMessage orderPaymentAddedMessage = OrderPaymentAddedMessage.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)
             .payment(paymentBuilder -> paymentBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_PAYMENT_ADDED	discriminator value for OrderPaymentAddedMessage

Method Summary

Modifier and Type	Method	Description
static OrderPaymentAddedMessageBuilder	builder()	builder factory method for OrderPaymentAddedMessage
static OrderPaymentAddedMessageBuilder	builder(OrderPaymentAddedMessage template)	create builder for OrderPaymentAddedMessage instance
static OrderPaymentAddedMessage	deepCopy(OrderPaymentAddedMessage template)	factory method to create a deep copy of OrderPaymentAddedMessage
@NotNull @Valid PaymentReference	getPayment()	Payment that was added to the Order.
static OrderPaymentAddedMessage	of()	factory method
static OrderPaymentAddedMessage	of(OrderPaymentAddedMessage template)	factory method to create a shallow copy OrderPaymentAddedMessage
void	setPayment(PaymentReference payment)	Payment that was added to the Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderPaymentAddedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPaymentAddedMessage(Function<OrderPaymentAddedMessage,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

Field Details

ORDER_PAYMENT_ADDED

static final String ORDER_PAYMENT_ADDED

discriminator value for OrderPaymentAddedMessage

See Also:

• Constant Field Values

Method Details

getPayment

@NotNull
@Valid
@NotNull @Valid PaymentReference getPayment()

Payment that was added to the Order.

Returns:

payment

setPayment

void setPayment(PaymentReference payment)

Payment that was added to the Order.

Parameters:

payment - value to be set

of

static OrderPaymentAddedMessage of()

factory method

Returns:

instance of OrderPaymentAddedMessage

of

static OrderPaymentAddedMessage of(OrderPaymentAddedMessage template)

factory method to create a shallow copy OrderPaymentAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderPaymentAddedMessage deepCopy(@Nullable
 OrderPaymentAddedMessage template)

factory method to create a deep copy of OrderPaymentAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPaymentAddedMessageBuilder builder()

builder factory method for OrderPaymentAddedMessage

Returns:

builder

builder

static OrderPaymentAddedMessageBuilder builder(OrderPaymentAddedMessage template)

create builder for OrderPaymentAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPaymentAddedMessage

default <T> T withOrderPaymentAddedMessage(Function<OrderPaymentAddedMessage,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<OrderPaymentAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference