Package com.broadleafcommerce.tax.domain

Class TaxRequest

java.lang.Object
com.broadleafcommerce.tax.domain.TaxRequest
All Implemented Interfaces:
Serializable
@Deprecated public class TaxRequest extends Object implements Serializable
Deprecated.
Please use TaxCalculationResponse or one of its subclasses.
A grouping of items and address(es) to be used to determine taxes as a request DTO sent to TaxProvider. This represents a fulfillment group.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • TaxRequest

      public TaxRequest()
      Deprecated.

  • Method Details

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()
      Deprecated.

    • getTaxItems

      public List<TaxItem> getTaxItems()
      Deprecated.
      The list of items to be taxed.
      Returns:
      The list of items to be taxed.

    • getFromAddress

      public TaxAddress getFromAddress()
      Deprecated.
      The address that the items will be shipped from.
      Returns:
      The address that the items will be shipped from.

    • getToAddress

      public TaxAddress getToAddress()
      Deprecated.
      The address that the items will be shipped to.
      Returns:
      The address that the items will be shipped to.

    • getCustomer

      public String getCustomer()
      Deprecated.
      The customer that these taxes will apply to.
      Returns:
      The customer that these taxes will apply to.

    • getTaxId

      public String getTaxId()
      Deprecated.
      The tax id for this tax request
      Returns:
      The tax id for this tax request

    • getFulfillmentGroupReferenceNumber

      public String getFulfillmentGroupReferenceNumber()
      Deprecated.
      The fulfillment group reference number.
      Returns:
      The fulfillment group reference number

    • isTemporaryCalculation

      public boolean isTemporaryCalculation()
      Deprecated.
      For tax services that support it, records the transaction in the tax service for reporting purposes. (May require a separate commit operation with providers like Avalara)

    • getAttributes

      public Map<String,Object> getAttributes()
      Deprecated.
      Additional attributes for this tax group.
      Returns:
      Additional attributes for this tax group.

    • getProviderId

      public String getProviderId()
      Deprecated.
      The providerId indicates what provider returned the TaxResponse instances from a call to calculate taxes. This should be set to the same providerId as was returned from the last response. This may be used to try to use the same provider again, or to ensure that a call to commit or return taxes happens with the same provider used to calculate taxes.

    • setCurrency

      public void setCurrency(javax.money.CurrencyUnit currency)
      Deprecated.

    • setTaxItems

      public void setTaxItems(List<TaxItem> taxItems)
      Deprecated.
      The list of items to be taxed.
      Parameters:
      taxItems - The list of items to be taxed.

    • setFromAddress

      public void setFromAddress(TaxAddress fromAddress)
      Deprecated.
      The address that the items will be shipped from.
      Parameters:
      fromAddress - The address that the items will be shipped from.

    • setToAddress

      public void setToAddress(TaxAddress toAddress)
      Deprecated.
      The address that the items will be shipped to.
      Parameters:
      toAddress - The address that the items will be shipped to.

    • setCustomer

      public void setCustomer(String customer)
      Deprecated.
      The customer that these taxes will apply to.
      Parameters:
      customer - The customer that these taxes will apply to.

    • setTaxId

      public void setTaxId(String taxId)
      Deprecated.
      The tax id for this tax request
      Parameters:
      taxid - The tax id for this tax request.

    • setFulfillmentGroupReferenceNumber

      public void setFulfillmentGroupReferenceNumber(String fulfillmentGroupReferenceNumber)
      Deprecated.
      The fulfillment group reference number.
      Parameters:
      fulfillmentGroupReferenceNumber - The fulfillment group reference number

    • setTemporaryCalculation

      public void setTemporaryCalculation(boolean temporaryCalculation)
      Deprecated.
      For tax services that support it, records the transaction in the tax service for reporting purposes. (May require a separate commit operation with providers like Avalara)

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Deprecated.
      Additional attributes for this tax group.
      Parameters:
      attributes - Additional attributes for this tax group.

    • setProviderId

      public void setProviderId(String providerId)
      Deprecated.
      The providerId indicates what provider returned the TaxResponse instances from a call to calculate taxes. This should be set to the same providerId as was returned from the last response. This may be used to try to use the same provider again, or to ensure that a call to commit or return taxes happens with the same provider used to calculate taxes.

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)
      Deprecated.

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object