# com.beasys.commerce.ebusiness.tax
TaxParameters Interface

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

Related Topics

``TaxParametersHome``
``TaxParametersImpl``

All Known Implementing Classes
  `TaxParametersImpl`

All Superinterfaces
  `Belonging`, `BusinessSmartComponent`, `Cloneable`, `Comparable`, `Serializable`

## Field Summary

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

## Method Summary

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

Methods from interface `com.beasys.commerce.foundation.`Belonging``
``clone`, `equals`, `interfaceName`, `setByValue`, `value``

Methods from interface `java.lang.`Comparable``
`compareTo`

## Field Detail

### BUSINESSLOCATIONCODE

    public static final String BUSINESSLOCATIONCODE

### BUYERREGISTRATIONNUMBER

    public static final String BUYERREGISTRATIONNUMBER

### COMMIT

    public static final String COMMIT

### COMPANYID

    public static final String COMPANYID

### COUNTRYOFORIGIN

    public static final String COUNTRYOFORIGIN

### CREDIT

    public static final String CREDIT

### CURRENCY

    public static final String CURRENCY

### DATE

    public static final String DATE

### DELIVERYTERMS

    public static final String DELIVERYTERMS

### DISTANCESALEINDICATOR

    public static final String DISTANCESALEINDICATOR

### DOCUMENTNUMBER

    public static final String DOCUMENTNUMBER

### FREIGHT

    public static final String FREIGHT

### MODEOFTRANSPORT

    public static final String MODEOFTRANSPORT

### NETMASS

    public static final String NETMASS

### NOTC

    public static final String NOTC

### ORDERACCEPTANCE

    public static final String ORDERACCEPTANCE

### ORDERORIGIN

    public static final String ORDERORIGIN

### REGIONOFORIGINORDESTINATION

    public static final String REGIONOFORIGINORDESTINATION

### SELLERREGISTRATIONNUMBER

    public static final String SELLERREGISTRATIONNUMBER

### SHIPFROM

    public static final String SHIPFROM

### SHIPTO

    public static final String SHIPTO

### STATISTICALPROCEDURECODE

    public static final String STATISTICALPROCEDURECODE

### TAXDEBUG

    public static final String TAXDEBUG

### TAXSELPARM

    public static final String TAXSELPARM

### TAXTYPE

    public static final String TAXTYPE

### TITLEPASSAGE

    public static final String TITLEPASSAGE

### TRANSACTIONTYPE

    public static final String TRANSACTIONTYPE

### WTCODE

    public static final String WTCODE

## Method Detail

### addAttrib(String, Object) Method

    public void addAttrib(String name,
                          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.

### clearLocationMap() Method

    public void clearLocationMap()

Removes all mappings from this map (optional operation).

### equalsLocationMap(Object) Method

    public boolean equalsLocationMap(Object object)

Compares the specified object with this map for equality.

### getAttrib(String) Method

    public Object getAttrib(String name)

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

### getLocation(Object) Method

    public Address getLocation(Object key)

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

### getLocationMap() Method

    public Map getLocationMap()

Returns the entire map

### getOrderAttribs() Method

    public 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.

### isLocationMapEmpty() Method

    public boolean isLocationMapEmpty()

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

### locationMapContainsKey(Object) Method

    public boolean locationMapContainsKey(Object key)

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

### locationMapContainsValue(Address) Method

    public boolean locationMapContainsValue(Address element)

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

### locationMapEntrySet() Method

    public Set locationMapEntrySet()

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

### locationMapHashCode() Method

    public int locationMapHashCode()

Returns the hash code value for this map.

### locationMapIterator() Method

    public Iterator locationMapIterator()

Returns an iterator for this map

### locationMapKeySet() Method

    public Set locationMapKeySet()

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

### locationMapSize() Method

    public int locationMapSize()

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

### locationMapValues() Method

    public Collection locationMapValues()

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

### putLocation(Object, Address) Method

    public Address putLocation(Object key,
                               Address element)

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

### putLocationMap(Map) Method

    public void putLocationMap(Map map)

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

### removeLocation(Object) Method

    public Address removeLocation(Object key)

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

### setLocationMap(Map) Method

    public void setLocationMap(Map map)

Sets the entire map

### setOrderAttribs(TreeMap) Method

    public void setOrderAttribs(TreeMap orderAttribs)

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