Package com.broadleafcommerce.orderoperation.domain.payment

Class PaymentExecutionRequest

java.lang.Object
com.broadleafcommerce.orderoperation.domain.payment.PaymentExecutionRequest
All Implemented Interfaces:
Serializable
public class PaymentExecutionRequest extends Object implements Serializable
The domain that represent how much to execute against which payment, as well as its transaction type.
Author:
Sunny Yu
See Also:

  • Constructor Details

    • PaymentExecutionRequest

      public PaymentExecutionRequest()

  • Method Details

    • getCurrency

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

    • getPaymentId

      public String getPaymentId()

    • getAmount

      @Nullable public javax.money.MonetaryAmount getAmount()

    • setAmount

      public void setAmount(javax.money.MonetaryAmount amount)

    • getPayment

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

    • getTransactionType

      public String getTransactionType()
      The type of transaction that is to be executed.
      Returns:
      The type of transaction that is to be executed.

    • getTransactionAmountDetails

      public TransactionAmountDetails getTransactionAmountDetails()
      The amount for which this payment is executable
      Returns:
      The amount for which this payment is allotted.

    • getLineItems

      public List<TransactionLineItem> getLineItems()
      A collection of TransactionLineItems used to describe the items that are related to the requested transaction.
      Returns:
      A collection of TransactionLineItems used to describe the items that are related to the requested transaction.

    • 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 type of transaction that is to be executed.
      Parameters:
      transactionType - The type of transaction that is to be executed.

    • setTransactionAmountDetails

      public void setTransactionAmountDetails(TransactionAmountDetails transactionAmountDetails)
      The amount for which this payment is executable
      Parameters:
      amount - The amount for which this payment is allotted.

    • setLineItems

      public void setLineItems(List<TransactionLineItem> lineItems)
      A collection of TransactionLineItems used to describe the items that are related to the requested transaction.
      Parameters:
      lineItems - A collection of TransactionLineItems used to describe the items that are related to the requested transaction.

    • 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