SimpleTaxProvider (BroadleafCommerce Framework 4.0.18-GA API)

java.lang.Object
- org.broadleafcommerce.core.pricing.service.tax.provider.SimpleTaxProvider

All Implemented Interfaces:

ModuleProvider, TaxProvider
```
public class SimpleTaxProvider
extends Object
implements TaxProvider
```
Simple factor-based tax module that can be configured by adding rates for specific postalCodes, city, state, or country.
Through configuration, this module can be used to set a specific tax rate for items and shipping for a given postal code, city, state, or country.
Utilizes the fulfillment group's address to determine the tax location.
Useful for those with very simple tax needs that want to configure rates programmatically.

Author:

jfischer, brian polster, Phillip Verheyden (phillipuniverse)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Double`	`defaultFulfillmentGroupTaxRate`
`protected Double`	`defaultItemTaxRate`
`protected EntityConfiguration`	`entityConfig`
`protected Map<String,Double>`	`fulfillmentGroupCityTaxRateMap`
`protected Map<String,Double>`	`fulfillmentGroupCountryTaxRateMap`
`protected Map<String,Double>`	`fulfillmentGroupPostalCodeTaxRateMap`
`protected Map<String,Double>`	`fulfillmentGroupStateTaxRateMap`
`protected Map<String,Double>`	`itemCityTaxRateMap`
`protected Map<String,Double>`	`itemCountryTaxRateMap`
`protected Map<String,Double>`	`itemPostalCodeTaxRateMap`
`protected Map<String,Double>`	`itemStateTaxRateMap`
`protected boolean`	`taxFees`

Constructor Summary

Constructors
Constructor and Description

SimpleTaxProvider()

Constructors
Constructor and Description
`SimpleTaxProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`Order`	`calculateTaxForOrder(Order order, ModuleConfiguration config)` Calculates taxes on an entire order.
`void`	`cancelTax(Order order, ModuleConfiguration config)` Some tax providers store tax details from an order on an external system for reporting and tax reconcilliation.
`boolean`	`canRespond(ModuleConfiguration config)`
`Order`	`commitTaxForOrder(Order order, ModuleConfiguration config)` This method provides the implementation an opportunity to finalize taxes on the order.
`BigDecimal`	`determineItemTaxRate(Address address)` Uses the passed in address to determine if the item is taxable.
`BigDecimal`	`determineTaxRateForFulfillmentGroup(FulfillmentGroup fulfillmentGroup)` Uses the passed in address to determine if the item is taxable.
`Double`	`getDefaultFulfillmentGroupTaxRate()`
`Double`	`getDefaultItemTaxRate()`
`Map<String,Double>`	`getFulfillmentGroupCityTaxRateMap()`
`Map<String,Double>`	`getFulfillmentGroupCountryTaxRateMap()`
`Map<String,Double>`	`getFulfillmentGroupPostalCodeTaxRateMap()`
`Map<String,Double>`	`getFulfillmentGroupStateTaxRateMap()`
`Map<String,Double>`	`getItemCityTaxRateMap()`
`Map<String,Double>`	`getItemCountryTaxRateMap()`
`Map<String,Double>`	`getItemPostalCodeTaxRateMap()`
`Map<String,Double>`	`getItemStateTaxRateMap()`
`protected boolean`	`isFeeTaxable(FulfillmentGroupFee fee)`
`protected boolean`	`isItemTaxable(FulfillmentGroupItem item)`
`Double`	`lookupCityRate(Map<String,Double> cityTaxRateMap, String city)` Changes the city to upper case before checking the configuration.
`Double`	`lookupCountryRate(Map<String,Double> countryTaxRateMap, Country country)` Returns the taxAmount for the passed in country or null if no match is found.
`Double`	`lookupCountryRate(Map<String,Double> countryTaxRateMap, ISOCountry isoCountry)` Returns the taxAmount for the passed in country or null if no match is found.
`Double`	`lookupPostalCodeRate(Map<String,Double> postalCodeTaxRateMap, String postalCode)` Returns the taxAmount for the passed in postal code or null if no match is found.
`Double`	`lookupStateRate(Map<String,Double> stateTaxRateMap, State state)` Returns the taxAmount for the passed in state or null if no match is found.
`Double`	`lookupStateRate(Map<String,Double> stateTaxRateMap, String stateProvinceRegion)` Returns the taxAmount for the passed in stateProvinceRegion or null if no match is found.
`void`	`setDefaultFulfillmentGroupTaxRate(Double defaultFulfillmentGroupTaxRate)`
`void`	`setDefaultItemTaxRate(Double defaultItemTaxRate)`
`void`	`setFulfillmentGroupCityTaxRateMap(Map<String,Double> fulfillmentGroupCityTaxRateMap)`
`void`	`setFulfillmentGroupCountryTaxRateMap(Map<String,Double> fulfillmentGroupCountryTaxRateMap)`
`void`	`setFulfillmentGroupPostalCodeTaxRateMap(Map<String,Double> fulfillmentGroupPostalCodeTaxRateMap)`
`void`	`setFulfillmentGroupStateTaxRateMap(Map<String,Double> fulfillmentGroupStateTaxRateMap)`
`void`	`setItemCityTaxRateMap(Map<String,Double> itemCityTaxRateMap)`
`void`	`setItemCountryTaxRateMap(Map<String,Double> itemCountryTaxRateMap)`
`void`	`setItemPostalCodeTaxRateMap(Map<String,Double> itemPostalCodeTaxRateMap)`
`void`	`setItemStateTaxRateMap(Map<String,Double> itemStateTaxRateMap)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - itemPostalCodeTaxRateMap
```
protected Map<String,Double> itemPostalCodeTaxRateMap
```
  - itemCityTaxRateMap
```
protected Map<String,Double> itemCityTaxRateMap
```
  - itemStateTaxRateMap
```
protected Map<String,Double> itemStateTaxRateMap
```
  - itemCountryTaxRateMap
```
protected Map<String,Double> itemCountryTaxRateMap
```
  - fulfillmentGroupPostalCodeTaxRateMap
```
protected Map<String,Double> fulfillmentGroupPostalCodeTaxRateMap
```
  - fulfillmentGroupCityTaxRateMap
```
protected Map<String,Double> fulfillmentGroupCityTaxRateMap
```
  - fulfillmentGroupStateTaxRateMap
```
protected Map<String,Double> fulfillmentGroupStateTaxRateMap
```
  - fulfillmentGroupCountryTaxRateMap
```
protected Map<String,Double> fulfillmentGroupCountryTaxRateMap
```
  - defaultItemTaxRate
```
protected Double defaultItemTaxRate
```
  - defaultFulfillmentGroupTaxRate
```
protected Double defaultFulfillmentGroupTaxRate
```
  - taxFees
```
protected boolean taxFees
```
  - entityConfig
```
protected EntityConfiguration entityConfig
```
- Constructor Detail
  - SimpleTaxProvider
```
public SimpleTaxProvider()
```
- Method Detail
  - canRespond
```
public boolean canRespond(ModuleConfiguration config)
```
    Specified by:
    
    canRespond in interface ModuleProvider
  - calculateTaxForOrder
```
public Order calculateTaxForOrder(Order order,
                         ModuleConfiguration config)
                           throws TaxException
```
    Description copied from interface: TaxProvider
    
    Calculates taxes on an entire order. Returns the order with taxes included.
    
    Specified by:
    
    calculateTaxForOrder in interface TaxProvider
    
    Returns:
    
    Throws:
    
    TaxException
  - commitTaxForOrder
```
public Order commitTaxForOrder(Order order,
                      ModuleConfiguration config)
                        throws TaxException
```
    Description copied from interface: TaxProvider
    
    This method provides the implementation an opportunity to finalize taxes on the order. This is often required when tax sub systems require tax documents to be created on checkout. This method will typically be called by the checkout workflow, rather than by the pricing workflow. Some implementations may wish to do nothing in this method, except perhaps recalculate taxes.
    
    Specified by:
    
    commitTaxForOrder in interface TaxProvider
    
    Returns:
    
    Throws:
    
    TaxException
  - cancelTax
```
public void cancelTax(Order order,
             ModuleConfiguration config)
               throws TaxException
```
    Description copied from interface: TaxProvider
    
    Some tax providers store tax details from an order on an external system for reporting and tax reconcilliation. This allows one to cancel or undo tax recording in an external system. Typically, this will be called to offset a call to commitTaxForOrder. This might be called, for example, in a rollback handler for a checkout workflow activity that calls commitTaxForOrder. Many implementations may wish to do nothing in this method.
    
    Specified by:
    
    cancelTax in interface TaxProvider
    
    Throws:
    
    TaxException
  - lookupPostalCodeRate
```
public Double lookupPostalCodeRate(Map<String,Double> postalCodeTaxRateMap,
                          String postalCode)
```
    Returns the taxAmount for the passed in postal code or null if no match is found.
    
    Parameters:
    postalCode -
    
    Returns:
  - lookupCityRate
```
public Double lookupCityRate(Map<String,Double> cityTaxRateMap,
                    String city)
```
    Changes the city to upper case before checking the configuration. Return null if no match is found.
    
    Parameters:
    cityTaxRateMap, - city
    
    Returns:
  - lookupStateRate
```
public Double lookupStateRate(Map<String,Double> stateTaxRateMap,
                     State state)
```
    Returns the taxAmount for the passed in state or null if no match is found. First checks the abbreviation (uppercase) followed by the name (uppercase).
    
    Parameters:
    stateTaxRateMap, - state
    
    Returns:
  - lookupStateRate
```
public Double lookupStateRate(Map<String,Double> stateTaxRateMap,
                     String stateProvinceRegion)
```
    Returns the taxAmount for the passed in stateProvinceRegion or null if no match is found. First checks the abbreviation (uppercase) followed by the name (uppercase).
    
    Parameters:
    stateTaxRateMap, - stateProvinceRegion
    
    Returns:
  - lookupCountryRate
```
public Double lookupCountryRate(Map<String,Double> countryTaxRateMap,
                       Country country)
```
    Returns the taxAmount for the passed in country or null if no match is found. First checks the abbreviation (uppercase) followed by the name (uppercase).
    
    Parameters:
    countryTaxRateMap, - country
    
    Returns:
  - lookupCountryRate
```
public Double lookupCountryRate(Map<String,Double> countryTaxRateMap,
                       ISOCountry isoCountry)
```
    Returns the taxAmount for the passed in country or null if no match is found. First checks the alpha2 (uppercase) followed by the name (uppercase).
    
    Parameters:
    countryTaxRateMap, - isoCountry
    
    Returns:
  - isItemTaxable
```
protected boolean isItemTaxable(FulfillmentGroupItem item)
```
  - isFeeTaxable
```
protected boolean isFeeTaxable(FulfillmentGroupFee fee)
```
  - determineItemTaxRate
```
public BigDecimal determineItemTaxRate(Address address)
```
    Uses the passed in address to determine if the item is taxable. Checks the configured maps in order - (postal code, city, state, country)
    
    Parameters:
    address -
    
    Returns:
  - determineTaxRateForFulfillmentGroup
```
public BigDecimal determineTaxRateForFulfillmentGroup(FulfillmentGroup fulfillmentGroup)
```
    Uses the passed in address to determine if the item is taxable. Checks the configured maps in order - (postal code, city, state, country)
    
    Parameters:
    fulfillmentGroup -
    
    Returns:
  - getItemPostalCodeTaxRateMap
```
public Map<String,Double> getItemPostalCodeTaxRateMap()
```
  - setItemPostalCodeTaxRateMap
```
public void setItemPostalCodeTaxRateMap(Map<String,Double> itemPostalCodeTaxRateMap)
```
  - getItemCityTaxRateMap
```
public Map<String,Double> getItemCityTaxRateMap()
```
  - setItemCityTaxRateMap
```
public void setItemCityTaxRateMap(Map<String,Double> itemCityTaxRateMap)
```
  - getItemStateTaxRateMap
```
public Map<String,Double> getItemStateTaxRateMap()
```
  - setItemStateTaxRateMap
```
public void setItemStateTaxRateMap(Map<String,Double> itemStateTaxRateMap)
```
  - getItemCountryTaxRateMap
```
public Map<String,Double> getItemCountryTaxRateMap()
```
  - setItemCountryTaxRateMap
```
public void setItemCountryTaxRateMap(Map<String,Double> itemCountryTaxRateMap)
```
  - getFulfillmentGroupPostalCodeTaxRateMap
```
public Map<String,Double> getFulfillmentGroupPostalCodeTaxRateMap()
```
  - setFulfillmentGroupPostalCodeTaxRateMap
```
public void setFulfillmentGroupPostalCodeTaxRateMap(Map<String,Double> fulfillmentGroupPostalCodeTaxRateMap)
```
  - getFulfillmentGroupCityTaxRateMap
```
public Map<String,Double> getFulfillmentGroupCityTaxRateMap()
```
  - setFulfillmentGroupCityTaxRateMap
```
public void setFulfillmentGroupCityTaxRateMap(Map<String,Double> fulfillmentGroupCityTaxRateMap)
```
  - getFulfillmentGroupStateTaxRateMap
```
public Map<String,Double> getFulfillmentGroupStateTaxRateMap()
```
  - setFulfillmentGroupStateTaxRateMap
```
public void setFulfillmentGroupStateTaxRateMap(Map<String,Double> fulfillmentGroupStateTaxRateMap)
```
  - getFulfillmentGroupCountryTaxRateMap
```
public Map<String,Double> getFulfillmentGroupCountryTaxRateMap()
```
  - setFulfillmentGroupCountryTaxRateMap
```
public void setFulfillmentGroupCountryTaxRateMap(Map<String,Double> fulfillmentGroupCountryTaxRateMap)
```
  - getDefaultItemTaxRate
```
public Double getDefaultItemTaxRate()
```
  - setDefaultItemTaxRate
```
public void setDefaultItemTaxRate(Double defaultItemTaxRate)
```
  - getDefaultFulfillmentGroupTaxRate
```
public Double getDefaultFulfillmentGroupTaxRate()
```
  - setDefaultFulfillmentGroupTaxRate
```
public void setDefaultFulfillmentGroupTaxRate(Double defaultFulfillmentGroupTaxRate)
```

Class SimpleTaxProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

itemPostalCodeTaxRateMap

itemCityTaxRateMap

itemStateTaxRateMap

itemCountryTaxRateMap

fulfillmentGroupPostalCodeTaxRateMap

fulfillmentGroupCityTaxRateMap

fulfillmentGroupStateTaxRateMap

fulfillmentGroupCountryTaxRateMap

defaultItemTaxRate

defaultFulfillmentGroupTaxRate

taxFees

entityConfig

Constructor Detail

SimpleTaxProvider

Method Detail

canRespond

calculateTaxForOrder

commitTaxForOrder

cancelTax

lookupPostalCodeRate

lookupCityRate

lookupStateRate

lookupStateRate

lookupCountryRate

lookupCountryRate

isItemTaxable

isFeeTaxable

determineItemTaxRate

determineTaxRateForFulfillmentGroup

getItemPostalCodeTaxRateMap

setItemPostalCodeTaxRateMap

getItemCityTaxRateMap

setItemCityTaxRateMap

getItemStateTaxRateMap

setItemStateTaxRateMap

getItemCountryTaxRateMap

setItemCountryTaxRateMap

getFulfillmentGroupPostalCodeTaxRateMap

setFulfillmentGroupPostalCodeTaxRateMap

getFulfillmentGroupCityTaxRateMap

setFulfillmentGroupCityTaxRateMap

getFulfillmentGroupStateTaxRateMap

setFulfillmentGroupStateTaxRateMap

getFulfillmentGroupCountryTaxRateMap

setFulfillmentGroupCountryTaxRateMap

getDefaultItemTaxRate

setDefaultItemTaxRate

getDefaultFulfillmentGroupTaxRate

setDefaultFulfillmentGroupTaxRate