Package com.broadleafcommerce.orderoperation.domain.payment

Class PaymentDistributionDto

java.lang.Object
com.broadleafcommerce.orderoperation.domain.payment.PaymentDistributionDto
All Implemented Interfaces:
Serializable
public class PaymentDistributionDto extends Object implements Serializable
The DTO used to distribute a MonetaryAmount across different payments based on defined ratios.
Author:
Sunny Yu
See Also:

  • Constructor Details

    • PaymentDistributionDto

      public PaymentDistributionDto()

  • Method Details

    • getTotalAmountToDistribute

      public javax.money.MonetaryAmount getTotalAmountToDistribute()
      The total MonetaryAmount to distribute proportionally across different payments.

    • getExecutablePayments

      public List<ExecutablePayment> getExecutablePayments()
      A list of ExecutablePayments to distribute the totalAmountToDistribute across.

    • getPaymentDistributionDetails

      public List<com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail> getPaymentDistributionDetails()
      A list of PaymentDistributionDetails specifying the details of the distribution ratios.

    • getAdditionalAttributes

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

    • setTotalAmountToDistribute

      public void setTotalAmountToDistribute(javax.money.MonetaryAmount totalAmountToDistribute)
      The total MonetaryAmount to distribute proportionally across different payments.

    • setExecutablePayments

      public void setExecutablePayments(List<ExecutablePayment> executablePayments)
      A list of ExecutablePayments to distribute the totalAmountToDistribute across.

    • setPaymentDistributionDetails

      public void setPaymentDistributionDetails(List<com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail> paymentDistributionDetails)
      A list of PaymentDistributionDetails specifying the details of the distribution ratios.

    • 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