Package com.broadleafcommerce.billing.domain

Class BillingTaxDetail

java.lang.Object
com.broadleafcommerce.billing.domain.BillingTaxDetail
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.money.CurrencyConsumer, javax.money.CurrencySupplier
public class BillingTaxDetail extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, javax.money.CurrencySupplier, com.broadleafcommerce.money.CurrencyConsumer
This object contains information about tax as it applies to a particular BillingEventItem. These are created by the TaxCalculationProcessorHandler after tax is calculated by one of the tax processors.

  • Constructor Details

    • BillingTaxDetail

      public BillingTaxDetail()

    • BillingTaxDetail

      public BillingTaxDetail(String id, String billingEventItemId, BigDecimal amount, String taxCountry, String jurisdictionName, BigDecimal rate, String taxRegion, String taxName, String type, String currencyCode, javax.money.CurrencyUnit currency, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

  • Method Details

    • setCurrencyCode

      public void setCurrencyCode(String currencyCode)

    • setCurrency

      public void setCurrency(javax.money.CurrencyUnit currency)
      Specified by:
      setCurrency in interface com.broadleafcommerce.money.CurrencyConsumer

    • getId

      public String getId()

    • getBillingEventItemId

      public String getBillingEventItemId()
      References the billing event item.

    • getAmount

      public BigDecimal getAmount()
      The tax amount.

    • getTaxCountry

      public String getTaxCountry()
      The tax country.

    • getJurisdictionName

      public String getJurisdictionName()
      The name of the taxing jurisdiction.

    • getRate

      public BigDecimal getRate()
      The tax rate applied.

    • getTaxRegion

      public String getTaxRegion()
      The name of the taxing region.

    • getTaxName

      public String getTaxName()
      The name of the tax.

    • getType

      public String getType()
      The type of the tax. This is most usually the type of jurisdiction of this tax - e.g. region, city, etc.

    • getCurrencyCode

      @Deprecated public String getCurrencyCode()
      Deprecated.
      Use getCurrency() field instead
      The code of the currency.

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()
      The currency (“USD”, “CAD”, etc.)
      Specified by:
      getCurrency in interface javax.money.CurrencySupplier

    • 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

    • setId

      public void setId(String id)

    • setBillingEventItemId

      public void setBillingEventItemId(String billingEventItemId)
      References the billing event item.

    • setAmount

      public void setAmount(BigDecimal amount)
      The tax amount.

    • setTaxCountry

      public void setTaxCountry(String taxCountry)
      The tax country.

    • setJurisdictionName

      public void setJurisdictionName(String jurisdictionName)
      The name of the taxing jurisdiction.

    • setRate

      public void setRate(BigDecimal rate)
      The tax rate applied.

    • setTaxRegion

      public void setTaxRegion(String taxRegion)
      The name of the taxing region.

    • setTaxName

      public void setTaxName(String taxName)
      The name of the tax.

    • setType

      public void setType(String type)
      The type of the tax. This is most usually the type of jurisdiction of this tax - e.g. region, city, etc.

    • 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

    • 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