Package com.commercetools.api.models.message

Interface OrderPaymentAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface OrderPaymentAddedMessagePayload
extends MessagePayload

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

     OrderPaymentAddedMessagePayload orderPaymentAddedMessagePayload = OrderPaymentAddedMessagePayload.builder()
             .paymentRef(paymentRefBuilder -> paymentRefBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

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

Field Details

ORDER_PAYMENT_ADDED

static final String ORDER_PAYMENT_ADDED

discriminator value for OrderPaymentAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getPaymentRef

@NotNull
@Valid
@NotNull @Valid PaymentReference getPaymentRef()

Payment that was added to the Order.

Returns:

paymentRef

setPaymentRef

void setPaymentRef(PaymentReference paymentRef)

Payment that was added to the Order.

Parameters:

paymentRef - value to be set

of

static OrderPaymentAddedMessagePayload of()

factory method

Returns:

instance of OrderPaymentAddedMessagePayload

of

static OrderPaymentAddedMessagePayload of(OrderPaymentAddedMessagePayload template)

factory method to create a shallow copy OrderPaymentAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderPaymentAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static OrderPaymentAddedMessagePayload deepCopy(@Nullable
 OrderPaymentAddedMessagePayload template)

factory method to create a deep copy of OrderPaymentAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPaymentAddedMessagePayloadBuilder builder()

builder factory method for OrderPaymentAddedMessagePayload

Returns:

builder

builder

static OrderPaymentAddedMessagePayloadBuilder builder(OrderPaymentAddedMessagePayload template)

create builder for OrderPaymentAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPaymentAddedMessagePayload

default <T> T withOrderPaymentAddedMessagePayload(Function<OrderPaymentAddedMessagePayload,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<OrderPaymentAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference