com.beasys.commerce.ebusiness.tax
Interface TaxParameters

All Known Implementing Classes:

TaxParametersImpl

public interface TaxParameters

extends Belonging

Currently defined locations include: ShipTo ShipFrom OrderAcceptance OrderOrigin Currently defined order-based attributes include: (listed with "name" (type) (default) explanation. None are required.) freight (com.beasys.commerce.axiom.units.Price)(0) commit (Boolean) (True) store the tax in the audit file or not credit (Boolean) (False) for credit transactions titlePassage(Char) (D)-O for point of Origin, D for point of Delivery date (java.sql.Date) (current system Date) date of tax taxType (Character) (S) S for sales tax U for use tax companyID (String) (PlaceHolder) The name of the source company for the transaction overrideTax (Double) (0) The override tax rate as a fraction, 0.0 means no override sellerRegistrationNumber (String) (null) the seller registration number, used in world tax Attribute: location

• Containment: By Value
• Multiplicity: 0:N
• Interface: java.util.Map

See Also:

TaxParametersHome, TaxParametersImpl

Field Summary

static java.lang.String	BUSINESSLOCATIONCODE
static java.lang.String	BUYERREGISTRATIONNUMBER
static java.lang.String	COMMIT
static java.lang.String	COMPANYID
static java.lang.String	COUNTRYOFORIGIN
static java.lang.String	CREDIT
static java.lang.String	CURRENCY
static java.lang.String	DATE
static java.lang.String	DELIVERYTERMS
static java.lang.String	DISTANCESALEINDICATOR
static java.lang.String	DOCUMENTNUMBER
static java.lang.String	FREIGHT
static java.lang.String	MODEOFTRANSPORT
static java.lang.String	NETMASS
static java.lang.String	NOTC
static java.lang.String	ORDERACCEPTANCE
static java.lang.String	ORDERORIGIN
static java.lang.String	REGIONOFORIGINORDESTINATION
static java.lang.String	SELLERREGISTRATIONNUMBER
static java.lang.String	SHIPFROM
static java.lang.String	SHIPTO
static java.lang.String	STATISTICALPROCEDURECODE
static java.lang.String	TAXDEBUG
static java.lang.String	TAXSELPARM
static java.lang.String	TAXTYPE
static java.lang.String	TITLEPASSAGE
static java.lang.String	TRANSACTIONTYPE
static java.lang.String	WTCODE

Method Summary

void	addAttrib(java.lang.String name, java.lang.Object obj) adds an attribute to the attributes in TaxParameter.
void	clearLocationMap() Removes all mappings from this map (optional operation).
boolean	equalsLocationMap(java.lang.Object object) Compares the specified object with this map for equality.
java.lang.Object	getAttrib(java.lang.String name) returns an object that has the given string as attirbute.
com.beasys.commerce.axiom.contact.Address	getLocation(java.lang.Object key) Returns the value to which this map maps the specified key.
java.util.Map	getLocationMap() Returns the entire map
java.util.TreeMap	getOrderAttribs() For ease of use, in case the same parameters need to be reused.
boolean	isLocationMapEmpty() Returns true if this map contains no key-value mappings.
boolean	locationMapContainsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	locationMapContainsValue(com.beasys.commerce.axiom.contact.Address element) Returns true if this map maps one or more keys to the specified value.
java.util.Set	locationMapEntrySet() Returns a set view of the mappings contained in this map.
int	locationMapHashCode() Returns the hash code value for this map.
java.util.Iterator	locationMapIterator() Returns an iterator for this map
java.util.Set	locationMapKeySet() Returns a set view of the keys contained in this map.
int	locationMapSize() Returns the number of key-value mappings in this map.
java.util.Collection	locationMapValues() Returns a collection view of the values contained in this map.
com.beasys.commerce.axiom.contact.Address	putLocation(java.lang.Object key, com.beasys.commerce.axiom.contact.Address element) Associates the specified value with the specified key in this map (optional operation).
void	putLocationMap(java.util.Map map) Copies all of the mappings from the specified map to this map (optional operation).
com.beasys.commerce.axiom.contact.Address	removeLocation(java.lang.Object key) Removes the mapping for this key from this map if present (optional operation).
void	setLocationMap(java.util.Map map) Sets the entire map
void	setOrderAttribs(java.util.TreeMap orderAttribs) For ease of use, if desired, the entire set of attributes may be set.

Methods inherited from interface com.beasys.commerce.foundation.Belonging

clone, equals, interfaceName, setByValue, value

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

SHIPTO

public static final java.lang.String SHIPTO

SHIPFROM

public static final java.lang.String SHIPFROM

ORDERACCEPTANCE

public static final java.lang.String ORDERACCEPTANCE

ORDERORIGIN

public static final java.lang.String ORDERORIGIN

COMMIT

public static final java.lang.String COMMIT

CREDIT

public static final java.lang.String CREDIT

TITLEPASSAGE

public static final java.lang.String TITLEPASSAGE

COMPANYID

public static final java.lang.String COMPANYID

BUSINESSLOCATIONCODE

public static final java.lang.String BUSINESSLOCATIONCODE

DATE

public static final java.lang.String DATE

TAXTYPE

public static final java.lang.String TAXTYPE

CURRENCY

public static final java.lang.String CURRENCY

FREIGHT

public static final java.lang.String FREIGHT

TRANSACTIONTYPE

public static final java.lang.String TRANSACTIONTYPE

WTCODE

public static final java.lang.String WTCODE

DOCUMENTNUMBER

public static final java.lang.String DOCUMENTNUMBER

DISTANCESALEINDICATOR

public static final java.lang.String DISTANCESALEINDICATOR

MODEOFTRANSPORT

public static final java.lang.String MODEOFTRANSPORT

COUNTRYOFORIGIN

public static final java.lang.String COUNTRYOFORIGIN

REGIONOFORIGINORDESTINATION

public static final java.lang.String REGIONOFORIGINORDESTINATION

DELIVERYTERMS

public static final java.lang.String DELIVERYTERMS

NOTC

public static final java.lang.String NOTC

TAXSELPARM

public static final java.lang.String TAXSELPARM

STATISTICALPROCEDURECODE

public static final java.lang.String STATISTICALPROCEDURECODE

NETMASS

public static final java.lang.String NETMASS

SELLERREGISTRATIONNUMBER

public static final java.lang.String SELLERREGISTRATIONNUMBER

BUYERREGISTRATIONNUMBER

public static final java.lang.String BUYERREGISTRATIONNUMBER

TAXDEBUG

public static final java.lang.String TAXDEBUG

Method Detail

getLocationMap

public java.util.Map getLocationMap()

Returns the entire map

setLocationMap

public void setLocationMap(java.util.Map map)

Sets the entire map

locationMapIterator

public java.util.Iterator locationMapIterator()

Returns an iterator for this map

clearLocationMap

public void clearLocationMap()

Removes all mappings from this map (optional operation).

locationMapContainsKey

public boolean locationMapContainsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key.

locationMapContainsValue

public boolean locationMapContainsValue(com.beasys.commerce.axiom.contact.Address element)

Returns true if this map maps one or more keys to the specified value.

locationMapEntrySet

public java.util.Set locationMapEntrySet()

Returns a set view of the mappings contained in this map.

equalsLocationMap

public boolean equalsLocationMap(java.lang.Object object)

Compares the specified object with this map for equality.

getLocation

public com.beasys.commerce.axiom.contact.Address getLocation(java.lang.Object key)

Returns the value to which this map maps the specified key.

locationMapHashCode

public int locationMapHashCode()

Returns the hash code value for this map.

isLocationMapEmpty

public boolean isLocationMapEmpty()

Returns true if this map contains no key-value mappings.

locationMapKeySet

public java.util.Set locationMapKeySet()

Returns a set view of the keys contained in this map.

putLocation

public com.beasys.commerce.axiom.contact.Address putLocation(java.lang.Object key,
                                                             com.beasys.commerce.axiom.contact.Address element)

Associates the specified value with the specified key in this map (optional operation).

putLocationMap

public void putLocationMap(java.util.Map map)

Copies all of the mappings from the specified map to this map (optional operation).

removeLocation

public com.beasys.commerce.axiom.contact.Address removeLocation(java.lang.Object key)

Removes the mapping for this key from this map if present (optional operation).

locationMapSize

public int locationMapSize()

Returns the number of key-value mappings in this map.

locationMapValues

public java.util.Collection locationMapValues()

Returns a collection view of the values contained in this map.

addAttrib

public void addAttrib(java.lang.String name,
                      java.lang.Object obj)

adds an attribute to the attributes in TaxParameter. If a map does not exist, it will be created. Address attributes should be set via the accessors to the location collection.

getAttrib

public java.lang.Object getAttrib(java.lang.String name)

returns an object that has the given string as attirbute. If the attribute does not exist, then it returns null.

setOrderAttribs

public void setOrderAttribs(java.util.TreeMap orderAttribs)

For ease of use, if desired, the entire set of attributes may be set.

getOrderAttribs

public java.util.TreeMap getOrderAttribs()

For ease of use, in case the same parameters need to be reused. Note that the locations collection is not included in the treemap returned.