Package org.broadleafcommerce.core.order.domain

Class TaxDetailImpl

java.lang.Object

org.broadleafcommerce.core.order.domain.TaxDetailImpl

All Implemented Interfaces:

Serializable, MultiTenantCloneable<TaxDetail>, TaxDetail

@Entity
public class TaxDetailImpl
extends Object
implements TaxDetail

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	amount
protected String	country
protected BroadleafCurrency	currency
protected Long	id
protected String	jurisdictionName
protected ModuleConfiguration	moduleConfiguation
protected BigDecimal	rate
protected String	region
protected String	taxName
protected String	type

Constructor Summary

Constructors

Constructor	Description
TaxDetailImpl()
TaxDetailImpl(TaxType type, Money amount, BigDecimal rate)

Method Summary

Modifier and Type	Method	Description
CreateResponse<TaxDetail>	createOrRetrieveCopyInstance(MultiTenantCopyContext context)
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

Methods inherited from class java.lang.Object

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

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 BroadleafCurrency currency

moduleConfiguation

protected ModuleConfiguration moduleConfiguation

Constructor Details

TaxDetailImpl

public TaxDetailImpl()

TaxDetailImpl

public TaxDetailImpl(TaxType type,
 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 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(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 BroadleafCurrency getCurrency()

Specified by:

getCurrency in interface TaxDetail

setCurrency

public void setCurrency(BroadleafCurrency currency)

Specified by:

setCurrency in interface TaxDetail

getModuleConfiguration

public 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(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 CreateResponse<TaxDetail> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                       throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<TaxDetail>

Throws:

CloneNotSupportedException