Package com.broadleafcommerce.orderoperation.domain.payment

Class ExecutablePayment

java.lang.Object
com.broadleafcommerce.orderoperation.domain.payment.ExecutablePayment
All Implemented Interfaces:
Serializable
public class ExecutablePayment extends Object implements Serializable
The domain that represents a PaymentSummary with its executable amount for a transaction type. Note: These objects are meant to describe what's possible with the payment for the transaction type, not necessarily what will be executed against the payment. For details on what will be executed for a given fulfillment or return action, see usages of the PaymentExecutionRequest.
Author:
Sunny Yu
See Also:

  • Constructor Details

    • ExecutablePayment

      public ExecutablePayment()

  • Method Details

    • getCurrency

      @Nullable public javax.money.CurrencyUnit getCurrency()
      The currency gathered from getExecutableAmount()
      Returns:
      The currency gathered from the amount

    • getPaymentId

      public String getPaymentId()

    • getPayment

      public PaymentSummary getPayment()
      The id of this payment.
      Returns:
      The id of this payment.

    • getTransactionType

      public String getTransactionType()
      The executable transaction type of this payment.
      Returns:
      The type of this payment like Credit Card or Gift Card.

    • getExecutableAmount

      public javax.money.MonetaryAmount getExecutableAmount()
      The amount for which this payment is executable
      Returns:
      The amount for which this payment is allotted.

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      Contains the additional information about this payment.
      Returns:
      the map with the additional information about this payment

    • setPayment

      public void setPayment(PaymentSummary payment)
      The id of this payment.
      Parameters:
      id - The id of this payment.

    • setTransactionType

      public void setTransactionType(String transactionType)
      The executable transaction type of this payment.
      Parameters:
      type - The type of this payment like Credit Card or Gift Card.

    • setExecutableAmount

      public void setExecutableAmount(javax.money.MonetaryAmount executableAmount)
      The amount for which this payment is executable
      Parameters:
      amount - The amount for which this payment is allotted.

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Contains the additional information about this payment.
      Parameters:
      additionalAttributes - the map with the additional information about this payment

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object