org.broadleafcommerce.core.order.domain

Interface TaxDetail

All Superinterfaces:

Serializable

All Known Implementing Classes:

TaxDetailImpl

public interface TaxDetail
extends Serializable

The Interface TaxDetail. A TaxDetail object stores relevant tax information including a tax type, amount, and rate.

Method Summary

Methods

Modifier and Type	Method and Description
Money	getAmount() Gets the tax amount
String	getCountry() Returns the country, as a string, used for tax calculation.
BroadleafCurrency	getCurrency()
Long	getId() Gets the id.
String	getJurisdictionName() Returns the name of the tax jurisdiction.
ModuleConfiguration	getModuleConfiguration() Returns the configuration of the module that was used to calculate taxes.
BigDecimal	getRate() Gets the tax rate
String	getRegion() Returns the name of the region used for tax calculation.
String	getTaxName() Gets the name of the tax.
TaxType	getType() Gets the tax type
void	setAmount(Money amount) Sets the tax amount
void	setCountry(String country) Sets the country used for tax calculation.
void	setCurrency(BroadleafCurrency currency)
void	setId(Long id) Sets the id.
void	setJurisdictionName(String jurisdiction) Optionally sets the name of the tax jurisdiction.
void	setModuleConfiguration(ModuleConfiguration config) Sets the module configuration that was used to calculate taxes.
void	setRate(BigDecimal rate) Sets the tax rate.
void	setRegion(String region) Sets the region, as a string.
void	setTaxName(String taxName) Sets the name of the tax, if applicable.
void	setType(TaxType type) Sets the tax type

Method Detail

getId

Long getId()

Gets the id.

Returns:

the id

setId

void setId(Long id)

Sets the id.

Parameters:

id - the new id

getType

TaxType getType()

Gets the tax type

Returns:

the tax type

setType

void setType(TaxType type)

Sets the tax type

Parameters:

type - the tax type

getAmount

Money getAmount()

Gets the tax amount

Returns:

the tax amount

setAmount

void setAmount(Money amount)

Sets the tax amount

Parameters:

amount - the tax amount

getRate

BigDecimal getRate()

Gets the tax rate

Returns:

the rate

setRate

void setRate(BigDecimal rate)

Sets the tax rate.

Parameters:

name - the tax rate

getCurrency

BroadleafCurrency getCurrency()

setCurrency

void setCurrency(BroadleafCurrency currency)

getModuleConfiguration

ModuleConfiguration getModuleConfiguration()

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.

Returns:

setModuleConfiguration

void setModuleConfiguration(ModuleConfiguration config)

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.

Parameters:

config -

setJurisdictionName

void setJurisdictionName(String jurisdiction)

Optionally sets the name of the tax jurisdiction.

Parameters:

jurisdiction -

getJurisdictionName

String getJurisdictionName()

Returns the name of the tax jurisdiction. May return null.

Returns:

setTaxName

void setTaxName(String taxName)

Sets the name of the tax, if applicable.

Parameters:

taxName -

getTaxName

String getTaxName()

Gets the name of the tax. May return null.

Returns:

setRegion

void setRegion(String region)

Sets the region, as a string. Typically this will be a State, Province, or County.

Parameters:

region -

getRegion

String getRegion()

Returns the name of the region used for tax calculation. May return null.

Returns:

setCountry

void setCountry(String country)

Sets the country used for tax calculation.

Parameters:

country -

getCountry

String getCountry()

Returns the country, as a string, used for tax calculation. May return null.

Returns: