org.broadleafcommerce.core.pricing.service.module

Class SimpleTaxModule

java.lang.Object

org.broadleafcommerce.core.pricing.service.module.SimpleTaxModule

All Implemented Interfaces:

TaxModule

Deprecated.

@Deprecated
public class SimpleTaxModule
extends java.lang.Object
implements TaxModule

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.

Author:

jfischer, brian polster

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Double	defaultFulfillmentGroupTaxRate Deprecated.
protected java.lang.Double	defaultItemTaxRate Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	fulfillmentGroupCityTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	fulfillmentGroupCountryTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	fulfillmentGroupPostalCodeTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	fulfillmentGroupStateTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	itemCityTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	itemCountryTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	itemPostalCodeTaxRateMap Deprecated.
protected java.util.Map<java.lang.String,java.lang.Double>	itemStateTaxRateMap Deprecated.
static java.lang.String	MODULENAME Deprecated.
protected java.lang.String	name Deprecated.
protected boolean	taxFees Deprecated.

Constructor Summary

Constructors

Constructor and Description
SimpleTaxModule() Deprecated.

Method Summary

Modifier and Type	Method and Description
Order	calculateTaxForOrder(Order order) Deprecated.
java.lang.Double	determineItemTaxRate(Address address) Deprecated. Uses the passed in address to determine if the item is taxable.
java.lang.Double	determineTaxRateForFulfillmentGroup(FulfillmentGroup fulfillmentGroup) Deprecated. Uses the passed in address to determine if the item is taxable.
java.lang.Double	getDefaultFulfillmentGroupTaxRate() Deprecated.
java.lang.Double	getDefaultItemTaxRate() Deprecated.
java.lang.Double	getFactor() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getFulfillmentGroupCityTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getFulfillmentGroupCountryTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getFulfillmentGroupPostalCodeTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getFulfillmentGroupStateTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getItemCityTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getItemCountryTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getItemPostalCodeTaxRateMap() Deprecated.
java.util.Map<java.lang.String,java.lang.Double>	getItemStateTaxRateMap() Deprecated.
java.lang.String	getName() Deprecated.
protected boolean	isFeeTaxable(FulfillmentGroupFee fee) Deprecated.
protected boolean	isItemTaxable(FulfillmentGroupItem item) Deprecated.
java.lang.Double	lookupCityRate(java.util.Map<java.lang.String,java.lang.Double> cityTaxRateMap, java.lang.String city) Deprecated. Changes the city to upper case before checking the configuration.
java.lang.Double	lookupCountryRate(java.util.Map<java.lang.String,java.lang.Double> countryTaxRateMap, Country country) Deprecated. Returns the taxAmount for the passed in country or null if no match is found.
java.lang.Double	lookupPostalCodeRate(java.util.Map<java.lang.String,java.lang.Double> postalCodeTaxRateMap, java.lang.String postalCode) Deprecated. Returns the taxAmount for the passed in postal code or null if no match is found.
java.lang.Double	lookupStateRate(java.util.Map<java.lang.String,java.lang.Double> stateTaxRateMap, State state) Deprecated. Returns the taxAmount for the passed in state or null if no match is found.
void	setDefaultFulfillmentGroupTaxRate(java.lang.Double defaultFulfillmentGroupTaxRate) Deprecated.
void	setDefaultItemTaxRate(java.lang.Double defaultItemTaxRate) Deprecated.
void	setFactor(java.lang.Double factor) Deprecated.
void	setFulfillmentGroupCityTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCityTaxRateMap) Deprecated.
void	setFulfillmentGroupCountryTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCountryTaxRateMap) Deprecated.
void	setFulfillmentGroupPostalCodeTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupPostalCodeTaxRateMap) Deprecated.
void	setFulfillmentGroupStateTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupStateTaxRateMap) Deprecated.
void	setItemCityTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemCityTaxRateMap) Deprecated.
void	setItemCountryTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemCountryTaxRateMap) Deprecated.
void	setItemPostalCodeTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemPostalCodeTaxRateMap) Deprecated.
void	setItemStateTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemStateTaxRateMap) Deprecated.
void	setName(java.lang.String name) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULENAME

public static final java.lang.String MODULENAME

Deprecated.

See Also:

Constant Field Values

name

protected java.lang.String name

Deprecated.

itemPostalCodeTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> itemPostalCodeTaxRateMap

Deprecated.

itemCityTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> itemCityTaxRateMap

Deprecated.

itemStateTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> itemStateTaxRateMap

Deprecated.

itemCountryTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> itemCountryTaxRateMap

Deprecated.

fulfillmentGroupPostalCodeTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupPostalCodeTaxRateMap

Deprecated.

fulfillmentGroupCityTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCityTaxRateMap

Deprecated.

fulfillmentGroupStateTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupStateTaxRateMap

Deprecated.

fulfillmentGroupCountryTaxRateMap

protected java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCountryTaxRateMap

Deprecated.

defaultItemTaxRate

protected java.lang.Double defaultItemTaxRate

Deprecated.

defaultFulfillmentGroupTaxRate

protected java.lang.Double defaultFulfillmentGroupTaxRate

Deprecated.

taxFees

protected boolean taxFees

Deprecated.

Constructor Detail

SimpleTaxModule

public SimpleTaxModule()

Deprecated.

Method Detail

calculateTaxForOrder

public Order calculateTaxForOrder(Order order)
                           throws TaxException

Deprecated.

Specified by:

calculateTaxForOrder in interface TaxModule

Throws:

TaxException

getName

public java.lang.String getName()

Deprecated.

Specified by:

getName in interface TaxModule

setName

public void setName(java.lang.String name)

Deprecated.

Specified by:

setName in interface TaxModule

lookupPostalCodeRate

public java.lang.Double lookupPostalCodeRate(java.util.Map<java.lang.String,java.lang.Double> postalCodeTaxRateMap,
                                             java.lang.String postalCode)

Deprecated.

Returns the taxAmount for the passed in postal code or null if no match is found.

Parameters:

postalCode -

Returns:

lookupCityRate

public java.lang.Double lookupCityRate(java.util.Map<java.lang.String,java.lang.Double> cityTaxRateMap,
                                       java.lang.String city)

Deprecated.

Changes the city to upper case before checking the configuration. Return null if no match is found.

Parameters:

cityTaxRateMap, - city

Returns:

lookupStateRate

public java.lang.Double lookupStateRate(java.util.Map<java.lang.String,java.lang.Double> stateTaxRateMap,
                                        State state)

Deprecated.

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:

lookupCountryRate

public java.lang.Double lookupCountryRate(java.util.Map<java.lang.String,java.lang.Double> countryTaxRateMap,
                                          Country country)

Deprecated.

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, - state

Returns:

isItemTaxable

protected boolean isItemTaxable(FulfillmentGroupItem item)

Deprecated.

isFeeTaxable

protected boolean isFeeTaxable(FulfillmentGroupFee fee)

Deprecated.

determineItemTaxRate

public java.lang.Double determineItemTaxRate(Address address)

Deprecated.

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 java.lang.Double determineTaxRateForFulfillmentGroup(FulfillmentGroup fulfillmentGroup)

Deprecated.

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 java.util.Map<java.lang.String,java.lang.Double> getItemPostalCodeTaxRateMap()

Deprecated.

setItemPostalCodeTaxRateMap

public void setItemPostalCodeTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemPostalCodeTaxRateMap)

Deprecated.

getItemCityTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getItemCityTaxRateMap()

Deprecated.

setItemCityTaxRateMap

public void setItemCityTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemCityTaxRateMap)

Deprecated.

getItemStateTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getItemStateTaxRateMap()

Deprecated.

setItemStateTaxRateMap

public void setItemStateTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemStateTaxRateMap)

Deprecated.

getItemCountryTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getItemCountryTaxRateMap()

Deprecated.

setItemCountryTaxRateMap

public void setItemCountryTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> itemCountryTaxRateMap)

Deprecated.

getFulfillmentGroupPostalCodeTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getFulfillmentGroupPostalCodeTaxRateMap()

Deprecated.

setFulfillmentGroupPostalCodeTaxRateMap

public void setFulfillmentGroupPostalCodeTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupPostalCodeTaxRateMap)

Deprecated.

getFulfillmentGroupCityTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getFulfillmentGroupCityTaxRateMap()

Deprecated.

setFulfillmentGroupCityTaxRateMap

public void setFulfillmentGroupCityTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCityTaxRateMap)

Deprecated.

getFulfillmentGroupStateTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getFulfillmentGroupStateTaxRateMap()

Deprecated.

setFulfillmentGroupStateTaxRateMap

public void setFulfillmentGroupStateTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupStateTaxRateMap)

Deprecated.

getFulfillmentGroupCountryTaxRateMap

public java.util.Map<java.lang.String,java.lang.Double> getFulfillmentGroupCountryTaxRateMap()

Deprecated.

setFulfillmentGroupCountryTaxRateMap

public void setFulfillmentGroupCountryTaxRateMap(java.util.Map<java.lang.String,java.lang.Double> fulfillmentGroupCountryTaxRateMap)

Deprecated.

getDefaultItemTaxRate

public java.lang.Double getDefaultItemTaxRate()

Deprecated.

setDefaultItemTaxRate

public void setDefaultItemTaxRate(java.lang.Double defaultItemTaxRate)

Deprecated.

getDefaultFulfillmentGroupTaxRate

public java.lang.Double getDefaultFulfillmentGroupTaxRate()

Deprecated.

setDefaultFulfillmentGroupTaxRate

public void setDefaultFulfillmentGroupTaxRate(java.lang.Double defaultFulfillmentGroupTaxRate)

Deprecated.

getFactor

@Deprecated
public java.lang.Double getFactor()

Deprecated.

Use getDefaultItemTaxRate instead.

Returns:

setFactor

@Deprecated
public void setFactor(java.lang.Double factor)

Deprecated.

Use setDefaultItemTaxRate instead.