Package com.broadleafcommerce.order.client.domain

Class FulfillmentCaptureClaimSummary

java.lang.Object
com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary
All Implemented Interfaces:
Serializable
public class FulfillmentCaptureClaimSummary extends Object implements Serializable
Domain that summarizes the current state of capture transaction claims for a single fulfillment or payment.
Author:
Sunny Yu
See Also:

  • Constructor Details

    • FulfillmentCaptureClaimSummary

      public FulfillmentCaptureClaimSummary()

  • Method Details

    • getDiscriminatorType

      public String getDiscriminatorType()
      The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
      Returns:
      The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
      See Also:

    • getDiscriminatorId

      public String getDiscriminatorId()
      The id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment.

      For example, if the summary was built for a list of FulfillmentCaptureClaims with the same order fulfillment, then the value would be the order fulfillment id.

      Returns:
      the id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment

    • getTotalAmountClaimed

      public javax.money.MonetaryAmount getTotalAmountClaimed()
      Total amount claimed.
      Returns:
      the total amount claimed

    • getTotalAmountCaptured

      @Deprecated public javax.money.MonetaryAmount getTotalAmountCaptured()
      Deprecated.
      In favor of using the TransactionSummary concept from PaymentTransactionServices to understand the amount captured for a fulfillment, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
      Total amount captured.
      Returns:
      the total amount captured

    • getClaims

      public List<FulfillmentCaptureClaim> getClaims()
      The list of FulfillmentCaptureClaims for the OrderFulfillment.
      Returns:
      the list of FulfillmentCaptureClaims for the OrderFulfillment

    • setDiscriminatorType

      public void setDiscriminatorType(String discriminatorType)
      The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
      Parameters:
      discriminatorType - The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
      See Also:

    • setDiscriminatorId

      public void setDiscriminatorId(String discriminatorId)
      The id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment.

      For example, if the summary was built for a list of FulfillmentCaptureClaims with the same order fulfillment, then the value would be the order fulfillment id.

      Parameters:
      discriminatorId - the id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment

    • setTotalAmountClaimed

      public void setTotalAmountClaimed(javax.money.MonetaryAmount totalAmountClaimed)
      Total amount claimed.
      Parameters:
      totalAmountClaimed - the total amount claimed

    • setTotalAmountCaptured

      @Deprecated public void setTotalAmountCaptured(javax.money.MonetaryAmount totalAmountCaptured)
      Deprecated.
      In favor of using the TransactionSummary concept from PaymentTransactionServices to understand the amount captured for a fulfillment, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
      Total amount captured.
      Parameters:
      totalAmountCaptured - the total amount captured

    • setClaims

      public void setClaims(List<FulfillmentCaptureClaim> claims)
      The list of FulfillmentCaptureClaims for the OrderFulfillment.
      Parameters:
      claims - the list of FulfillmentCaptureClaims for the OrderFulfillment

    • 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