Package com.broadleafcommerce.order.client.domain

Class FulfillmentCaptureClaim

java.lang.Object
com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.money.CurrencyConsumer, Serializable, javax.money.CurrencySupplier
public class FulfillmentCaptureClaim extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable, javax.money.CurrencySupplier, com.broadleafcommerce.money.CurrencyConsumer
Domain used to represent an payment is captured for an OrderFulfillment, or when a previously-captured amount (typically from an AuthorizeAndCapture transaction executed during checkout) is claimed for an OrderFulfillment.
Author:
Sunny Yu
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    FulfillmentCaptureClaim()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    javax.money.MonetaryAmount
    getAmount()
    The amount that has been captured or claimed by the fulfillment against the payment.
    Map<String,Object>
    getAttributes()
    Additional attributes for this claim.
    com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
    getContextState()
    A subset of Tracking information to expose the context state for this object.
    javax.money.CurrencyUnit
    getCurrency()
    The currency unit used for monetary amounts.
    String
    getId()
    The context ID of this claim.
    String
    getOrderFulfillmentId()
    The context ID of the order fulfillment.
    String
    getPaymentId()
    The context ID of the payment that the claimed transaction belongs to.
    String
    getRequestId()
    The id representing the request to claim/execute one or more transactions.
    String
    getType()
    Deprecated.
    In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
    int
    hashCode()
     
    void
    setAmount(javax.money.MonetaryAmount amount)
    The amount that has been captured or claimed by the fulfillment against the payment.
    void
    setAttributes(Map<String,Object> attributes)
    Additional attributes for this claim.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
    A subset of Tracking information to expose the context state for this object.
    void
    setCurrency(javax.money.CurrencyUnit currency)
    The currency unit used for monetary amounts.
    void
    setId(String id)
    The context ID of this claim.
    void
    setOrderFulfillmentId(String orderFulfillmentId)
    The context ID of the order fulfillment.
    void
    setPaymentId(String paymentId)
    The context ID of the payment that the claimed transaction belongs to.
    void
    setRequestId(String requestId)
    The id representing the request to claim/execute one or more transactions.
    void
    setType(String type)
    Deprecated.
    In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FulfillmentCaptureClaim

      public FulfillmentCaptureClaim()

  • Method Details

    • getId

      public String getId()
      The context ID of this claim.
      Returns:
      the context ID of this claim

    • getOrderFulfillmentId

      public String getOrderFulfillmentId()
      The context ID of the order fulfillment.
      Returns:
      the context ID of the order fulfillment

    • getPaymentId

      public String getPaymentId()
      The context ID of the payment that the claimed transaction belongs to.
      Returns:
      the context ID of the payment that the claimed transaction belongs to

    • getRequestId

      public String getRequestId()
      The id representing the request to claim/execute one or more transactions.
      Returns:
      The id representing the request to claim/execute one or more transactions.

    • getType

      @Deprecated public String getType()
      Deprecated.
      In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
      Identifies whether the amount is for a new capture or for a claim against a previous capture.
      Returns:
      the type identifying whether the amount is for a new capture or for a claim against a previous capture.
      See Also:

    • getAmount

      public javax.money.MonetaryAmount getAmount()
      The amount that has been captured or claimed by the fulfillment against the payment.
      Returns:
      the amount that has been captured or claimed by the fulfillment against the payment

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()
      The currency unit used for monetary amounts.
      Specified by:
      getCurrency in interface javax.money.CurrencySupplier
      Returns:
      the currency unit used for monetary amounts

    • getAttributes

      public Map<String,Object> getAttributes()
      Additional attributes for this claim.
      Returns:
      additional attributes for this claim.

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The context ID of this claim.
      Parameters:
      id - the context ID of this claim

    • setOrderFulfillmentId

      public void setOrderFulfillmentId(String orderFulfillmentId)
      The context ID of the order fulfillment.
      Parameters:
      orderFulfillmentId - the context ID of the order fulfillment

    • setPaymentId

      public void setPaymentId(String paymentId)
      The context ID of the payment that the claimed transaction belongs to.
      Parameters:
      id - the context ID of the payment that the claimed transaction belongs to

    • setRequestId

      public void setRequestId(String requestId)
      The id representing the request to claim/execute one or more transactions.
      Parameters:
      requestId - The id representing the request to claim/execute one or more transactions.

    • setType

      @Deprecated public void setType(String type)
      Deprecated.
      In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
      Identifies whether the amount is for a new capture or for a claim against a previous capture.
      Parameters:
      type - the type identifying whether the amount is for a new capture or for a claim against a previous capture.
      See Also:

    • setAmount

      public void setAmount(javax.money.MonetaryAmount amount)
      The amount that has been captured or claimed by the fulfillment against the payment.
      Parameters:
      amount - the amount that has been captured or claimed by the fulfillment against the payment

    • setCurrency

      public void setCurrency(javax.money.CurrencyUnit currency)
      The currency unit used for monetary amounts.
      Specified by:
      setCurrency in interface com.broadleafcommerce.money.CurrencyConsumer
      Parameters:
      currency - the currency unit used for monetary amounts

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Additional attributes for this claim.
      Parameters:
      attributes - additional attributes for this claim.

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • 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