Package com.commercetools.api.models.message

Interface OrderPaymentRemovedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface OrderPaymentRemovedMessagePayload extends MessagePayload

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 

     OrderPaymentRemovedMessagePayload orderPaymentRemovedMessagePayload = OrderPaymentRemovedMessagePayload.builder()
             .paymentRef(paymentRefBuilder -> paymentRefBuilder)
             .removedPaymentInfo(true)
             .build()

  • Field Details

    • ORDER_PAYMENT_REMOVED

      static final String ORDER_PAYMENT_REMOVED
      discriminator value for OrderPaymentRemovedMessagePayload
      See Also:

  • 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 OrderPaymentRemovedMessagePayload of()
      factory method
      Returns:
      instance of OrderPaymentRemovedMessagePayload

    • of

      static OrderPaymentRemovedMessagePayload of(OrderPaymentRemovedMessagePayload template)
      factory method to create a shallow copy OrderPaymentRemovedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      OrderPaymentRemovedMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

      @Nullable static OrderPaymentRemovedMessagePayload deepCopy(@Nullable OrderPaymentRemovedMessagePayload template)
      factory method to create a deep copy of OrderPaymentRemovedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static OrderPaymentRemovedMessagePayloadBuilder builder()
      builder factory method for OrderPaymentRemovedMessagePayload
      Returns:
      builder

    • builder

      static OrderPaymentRemovedMessagePayloadBuilder builder(OrderPaymentRemovedMessagePayload template)
      create builder for OrderPaymentRemovedMessagePayload instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withOrderPaymentRemovedMessagePayload

      default <T> T withOrderPaymentRemovedMessagePayload(Function<OrderPaymentRemovedMessagePayload,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<OrderPaymentRemovedMessagePayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference