Package com.commercetools.api.models.message

Interface OrderPaymentRemovedMessage

All Superinterfaces:

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

public interface OrderPaymentRemovedMessage
extends Message

Generated after a successful Remove Payment update action or when a Payment is removed via Order Edits.

Example to create an instance using the builder pattern

     OrderPaymentRemovedMessage orderPaymentRemovedMessage = OrderPaymentRemovedMessage.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)
             .paymentRef(paymentRefBuilder -> paymentRefBuilder)
             .removedPaymentInfo(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_PAYMENT_REMOVED	discriminator value for OrderPaymentRemovedMessage

Method Summary

Modifier and Type	Method	Description
static OrderPaymentRemovedMessageBuilder	builder()	builder factory method for OrderPaymentRemovedMessage
static OrderPaymentRemovedMessageBuilder	builder(OrderPaymentRemovedMessage template)	create builder for OrderPaymentRemovedMessage instance
OrderPaymentRemovedMessage	copyDeep()
static OrderPaymentRemovedMessage	deepCopy(OrderPaymentRemovedMessage template)	factory method to create a deep copy of OrderPaymentRemovedMessage
@NotNull @Valid PaymentReference	getPaymentRef()	Payment that was removed from the Order.
@NotNull Boolean	getRemovedPaymentInfo()	Indicates whether the removal of the Payment resulted in no Payments remaining on the Order.
static OrderPaymentRemovedMessage	of()	factory method
static OrderPaymentRemovedMessage	of(OrderPaymentRemovedMessage template)	factory method to create a shallow copy OrderPaymentRemovedMessage
void	setPaymentRef(PaymentReference paymentRef)	Payment that was removed from the Order.
void	setRemovedPaymentInfo(Boolean removedPaymentInfo)	Indicates whether the removal of the Payment resulted in no Payments remaining on the Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderPaymentRemovedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPaymentRemovedMessage(Function<OrderPaymentRemovedMessage,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_REMOVED

static final String ORDER_PAYMENT_REMOVED

discriminator value for OrderPaymentRemovedMessage

See Also:

• Constant Field Values

Method Details

getPaymentRef

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

Payment that was removed from the Order.

Returns:

paymentRef

getRemovedPaymentInfo

@NotNull
@NotNull Boolean getRemovedPaymentInfo()

Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.

Returns:

removedPaymentInfo

setPaymentRef

void setPaymentRef(PaymentReference paymentRef)

Payment that was removed from the Order.

Parameters:

paymentRef - value to be set

setRemovedPaymentInfo

void setRemovedPaymentInfo(Boolean removedPaymentInfo)

Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.

Parameters:

removedPaymentInfo - value to be set

of

static OrderPaymentRemovedMessage of()

factory method

Returns:

instance of OrderPaymentRemovedMessage

of

static OrderPaymentRemovedMessage of(OrderPaymentRemovedMessage template)

factory method to create a shallow copy OrderPaymentRemovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderPaymentRemovedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static OrderPaymentRemovedMessage deepCopy(@Nullable
 OrderPaymentRemovedMessage template)

factory method to create a deep copy of OrderPaymentRemovedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPaymentRemovedMessageBuilder builder()

builder factory method for OrderPaymentRemovedMessage

Returns:

builder

builder

static OrderPaymentRemovedMessageBuilder builder(OrderPaymentRemovedMessage template)

create builder for OrderPaymentRemovedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPaymentRemovedMessage

default <T> T withOrderPaymentRemovedMessage(Function<OrderPaymentRemovedMessage,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<OrderPaymentRemovedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference