Package com.broadleafcommerce.order.client.domain

Class OrderFulfillmentItemTaxDetail

java.lang.Object
com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail
All Implemented Interfaces:
Serializable
public class OrderFulfillmentItemTaxDetail extends Object implements Serializable
Fine grained tax information about a fulfillment item. Certain fields may not be used depending on the TaxProvider currently in use.
Author:
cschneider
See Also:

  • Constructor Details

    • OrderFulfillmentItemTaxDetail

      public OrderFulfillmentItemTaxDetail(OrderFulfillmentItemTaxDetail taxDetail)
      Copy constructor for tax detail. Intended for use when splitting fulfillments. Does not copy the id field. Note that while this uses a different instance of the attributes map, any values inside the map will point to the same reference as the attribute in the original tax detail.
      Parameters:
      orderFulfillmentItemTaxDetail -

    • OrderFulfillmentItemTaxDetail

      public OrderFulfillmentItemTaxDetail()

  • Method Details

    • getSortName

      public String getSortName()
      Pseudo name for this tax detail, representing a combination of several items, used for sorting purposes.
      Returns:
      A sortable name

    • getId

      public String getId()
      The database id

    • getFulfillmentItem

      public OrderFulfillmentItem getFulfillmentItem()
      The fulfillment item for this tax detail

    • getTaxCalculated

      public javax.money.MonetaryAmount getTaxCalculated()
      The amount of taxes calculated.

    • getTaxableAmount

      public javax.money.MonetaryAmount getTaxableAmount()
      The amount that was taxable to determine the calculated tax.

    • getRate

      public BigDecimal getRate()
      The tax rate

    • getJurisdictionType

      public String getJurisdictionType()
      The jurisdiction type, e.g. city, state, county, etc.

    • getJurisdictionName

      public String getJurisdictionName()
      The tax jurisdiction name. This may be a state, city, county, etc. For example, "California", "New York City", etc.

    • getCountry

      public String getCountry()
      The 2 digit country code.

    • getRegion

      public String getRegion()
      The region that this tax was calculated. This may be something like the state, country, etc. For example, if the jurisdiction is Dallas, then the region would be Texas.

    • getTaxName

      public String getTaxName()
      The tax name for this tax detail. Describes the tax (e.g. TX STATE TAX)

    • getTransactionId

      public String getTransactionId()
      The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.

    • getAttributes

      public Map<String,Object> getAttributes()
      Additional attributes for this tax detail.

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()
      The currency for this tax detail.

    • isVat

      public boolean isVat()
      Declares whether the taxes were included in the provided subtotal. Note: this is a known misnomer.

    • setId

      public void setId(String id)
      The database id

    • setFulfillmentItem

      public void setFulfillmentItem(OrderFulfillmentItem fulfillmentItem)
      The fulfillment item for this tax detail

    • setTaxCalculated

      public void setTaxCalculated(javax.money.MonetaryAmount taxCalculated)
      The amount of taxes calculated.

    • setTaxableAmount

      public void setTaxableAmount(javax.money.MonetaryAmount taxableAmount)
      The amount that was taxable to determine the calculated tax.

    • setRate

      public void setRate(BigDecimal rate)
      The tax rate

    • setJurisdictionType

      public void setJurisdictionType(String jurisdictionType)
      The jurisdiction type, e.g. city, state, county, etc.

    • setJurisdictionName

      public void setJurisdictionName(String jurisdictionName)
      The tax jurisdiction name. This may be a state, city, county, etc. For example, "California", "New York City", etc.

    • setCountry

      public void setCountry(String country)
      The 2 digit country code.

    • setRegion

      public void setRegion(String region)
      The region that this tax was calculated. This may be something like the state, country, etc. For example, if the jurisdiction is Dallas, then the region would be Texas.

    • setTaxName

      public void setTaxName(String taxName)
      The tax name for this tax detail. Describes the tax (e.g. TX STATE TAX)

    • setTransactionId

      public void setTransactionId(String transactionId)
      The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Additional attributes for this tax detail.

    • setCurrency

      public void setCurrency(javax.money.CurrencyUnit currency)
      The currency for this tax detail.

    • setVat

      public void setVat(boolean isVat)
      Declares whether the taxes were included in the provided subtotal. Note: this is a known misnomer.

    • 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