Package org.broadleafcommerce.core.order.domain

Class TaxDetailImpl

java.lang.Object
org.broadleafcommerce.core.order.domain.TaxDetailImpl
All Implemented Interfaces:
Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<TaxDetail>, TaxDetail
@Entity public class TaxDetailImpl extends Object implements TaxDetail
See Also:

  • Field Details

    • id

      protected Long id

    • type

      protected String type

    • amount

      protected BigDecimal amount

    • rate

      protected BigDecimal rate

    • jurisdictionName

      protected String jurisdictionName

    • country

      protected String country

    • region

      protected String region

    • taxName

      protected String taxName

    • currency

      protected org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency

    • moduleConfiguation

      protected org.broadleafcommerce.common.config.domain.ModuleConfiguration moduleConfiguation

  • Constructor Details

    • TaxDetailImpl

      public TaxDetailImpl()

    • TaxDetailImpl

      public TaxDetailImpl(TaxType type, org.broadleafcommerce.common.money.Money amount, BigDecimal rate)

  • Method Details

    • getId

      public Long getId()
      Description copied from interface: TaxDetail
      Gets the id.
      Specified by:
      getId in interface TaxDetail
      Returns:
      the id

    • setId

      public void setId(Long id)
      Description copied from interface: TaxDetail
      Sets the id.
      Specified by:
      setId in interface TaxDetail
      Parameters:
      id - the new id

    • getType

      public TaxType getType()
      Description copied from interface: TaxDetail
      Gets the tax type
      Specified by:
      getType in interface TaxDetail
      Returns:
      the tax type

    • setType

      public void setType(TaxType type)
      Description copied from interface: TaxDetail
      Sets the tax type
      Specified by:
      setType in interface TaxDetail
      Parameters:
      type - the tax type

    • getAmount

      public org.broadleafcommerce.common.money.Money getAmount()
      Description copied from interface: TaxDetail
      Gets the tax amount
      Specified by:
      getAmount in interface TaxDetail
      Returns:
      the tax amount

    • setAmount

      public void setAmount(org.broadleafcommerce.common.money.Money amount)
      Description copied from interface: TaxDetail
      Sets the tax amount
      Specified by:
      setAmount in interface TaxDetail
      Parameters:
      amount - the tax amount

    • getRate

      public BigDecimal getRate()
      Description copied from interface: TaxDetail
      Gets the tax rate
      Specified by:
      getRate in interface TaxDetail
      Returns:
      the rate

    • setRate

      public void setRate(BigDecimal rate)
      Description copied from interface: TaxDetail
      Sets the tax rate.
      Specified by:
      setRate in interface TaxDetail
      Parameters:
      rate - name the tax rate

    • getCurrency

      public org.broadleafcommerce.common.currency.domain.BroadleafCurrency getCurrency()
      Specified by:
      getCurrency in interface TaxDetail

    • setCurrency

      public void setCurrency(org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency)
      Specified by:
      setCurrency in interface TaxDetail

    • getModuleConfiguration

      public org.broadleafcommerce.common.config.domain.ModuleConfiguration getModuleConfiguration()
      Description copied from interface: TaxDetail
      Returns the configuration of the module that was used to calculate taxes. Allows for tracking, especially when more than one module may be used by the system.
      Specified by:
      getModuleConfiguration in interface TaxDetail
      Returns:

    • setModuleConfiguration

      public void setModuleConfiguration(org.broadleafcommerce.common.config.domain.ModuleConfiguration config)
      Description copied from interface: TaxDetail
      Sets the module configuration that was used to calculate taxes. Allows for tracking of which module was used, especially in cases where more than one module is available over time.
      Specified by:
      setModuleConfiguration in interface TaxDetail

    • getJurisdictionName

      public String getJurisdictionName()
      Description copied from interface: TaxDetail
      Returns the name of the tax jurisdiction. May return null.
      Specified by:
      getJurisdictionName in interface TaxDetail
      Returns:

    • setJurisdictionName

      public void setJurisdictionName(String jurisdiction)
      Description copied from interface: TaxDetail
      Optionally sets the name of the tax jurisdiction.
      Specified by:
      setJurisdictionName in interface TaxDetail

    • getTaxName

      public String getTaxName()
      Description copied from interface: TaxDetail
      Gets the name of the tax. May return null.
      Specified by:
      getTaxName in interface TaxDetail
      Returns:

    • setTaxName

      public void setTaxName(String taxName)
      Description copied from interface: TaxDetail
      Sets the name of the tax, if applicable.
      Specified by:
      setTaxName in interface TaxDetail

    • getRegion

      public String getRegion()
      Description copied from interface: TaxDetail
      Returns the name of the region used for tax calculation. May return null.
      Specified by:
      getRegion in interface TaxDetail
      Returns:

    • setRegion

      public void setRegion(String region)
      Description copied from interface: TaxDetail
      Sets the region, as a string. Typically this will be a State, Province, or County.
      Specified by:
      setRegion in interface TaxDetail

    • getCountry

      public String getCountry()
      Description copied from interface: TaxDetail
      Returns the country, as a string, used for tax calculation. May return null.
      Specified by:
      getCountry in interface TaxDetail
      Returns:

    • setCountry

      public void setCountry(String country)
      Description copied from interface: TaxDetail
      Sets the country used for tax calculation.
      Specified by:
      setCountry in interface TaxDetail

    • createOrRetrieveCopyInstance

      public org.broadleafcommerce.common.copy.CreateResponse<TaxDetail> createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context) throws CloneNotSupportedException
      Specified by:
      createOrRetrieveCopyInstance in interface org.broadleafcommerce.common.copy.MultiTenantCloneable<TaxDetail>
      Throws:
      CloneNotSupportedException