# com.beasys.commerce.ebusiness.tax
TaxParametersImpl Class

public class TaxParametersImpl
extends `BelongingImpl`
implements `Cloneable`, `TaxParameters`

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

Related Topics

``TaxParameters``
``TaxParametersHome``

Hierarchy
  `Object`
  `BelongingImpl`
  `TaxParametersImpl`

All Implemented Interfaces
  `Belonging`, `BusinessSmartComponent`, `Cloneable`, `Comparable`, `RelationalReference`, `Serializable`, `TaxParameters`

## Field Summary

`public `Map`` | `location` Containment: By Value Multiplicity: 0:N Interface: java.util.Map
`public `TreeMap`` | `orderAttribs` TreeMap

Fields from com.beasys.commerce.foundation`.`BelongingImpl``
``__classIdentifier`, `__containingBelonging`, `__containingEntity`, `__mapKey`, `__sequenceNumber`, `_isDirty``

Fields from interface com.beasys.commerce.ebusiness.tax`.`TaxParameters``
``BUSINESSLOCATIONCODE`, `BUYERREGISTRATIONNUMBER`, `COMMIT`, `COMPANYID`, `COUNTRYOFORIGIN`, `CREDIT`, `CURRENCY`, `DATE`, `DELIVERYTERMS`, `DISTANCESALEINDICATOR`, `DOCUMENTNUMBER`, `FREIGHT`, `MODEOFTRANSPORT`, `NETMASS`, `NOTC`, `ORDERACCEPTANCE`, `ORDERORIGIN`, `REGIONOFORIGINORDESTINATION`, `SELLERREGISTRATIONNUMBER`, `SHIPFROM`, `SHIPTO`, `STATISTICALPROCEDURECODE`, `TAXDEBUG`, `TAXSELPARM`, `TAXTYPE`, `TITLEPASSAGE`, `TRANSACTIONTYPE`, `WTCODE``

## Constructor Summary

TaxParametersImpl()

## 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 int` | `compareTo`(`Object` o) Compare this belonging to another
`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 a deep copy of the entire collection
`public `TreeMap`` | `getOrderAttribs`() For ease of use, in case the same parameters need to be reused.
`public `String`` | `interfaceName`() interfaceName() returns the unqualified name of the interface from the UML model
`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 (deep copy) set view of the mappings contained in this map.
`public int` | `locationMapHashCode`() Returns the hash code value for this map.
`public `Iterator`` | `locationMapIterator`() Returns a (shallow) iterator for this map
`public `Set`` | `locationMapKeySet`() Returns a (deep copy) 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 (deep copy) 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` | `setByValue`(`Belonging` value) It is possible to call set-by-value with a superclass.
`public void` | `setLocationMap`(`Map` map) Sets the entire collection
`public void` | `setOrderAttribs`(`TreeMap` orderAttribs) For ease of use, if desired, the entire set of attributes may be set.
`public `Belonging`` | `value`() value() is a more typesafe implementation of clone()

Methods from `com.beasys.commerce.foundation.`BelongingImpl``
``clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clone`, `doRelationalBinding`, `doRelationalBinding`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `enumerateRelationalBinding`, `enumerateRelationalBinding`, `equals`, `get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__containingEntityReference`, `get__mapKey`, `get__sequenceNumber`, `getPersistenceHelperPlugin`, `hashCode`, `set__classIdentifier`, `set__containingBelonging`, `set__containingEntity`, `set__containingEntityReference`, `set__mapKey`, `toString``

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

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

Methods from interface `com.beasys.commerce.foundation.`RelationalReference``
``get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__mapKey`, `get__sequenceNumber`, `set__containingBelonging`, `set__containingEntity`, `set__mapKey``

Methods from interface `com.beasys.commerce.ebusiness.tax.`TaxParameters``
``addAttrib`, `clearLocationMap`, `equalsLocationMap`, `getAttrib`, `getLocation`, `getLocationMap`, `getOrderAttribs`, `isLocationMapEmpty`, `locationMapContainsKey`, `locationMapContainsValue`, `locationMapEntrySet`, `locationMapHashCode`, `locationMapIterator`, `locationMapKeySet`, `locationMapSize`, `locationMapValues`, `putLocation`, `putLocationMap`, `removeLocation`, `setLocationMap`, `setOrderAttribs``

## Field Detail

### location

    public Map location

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

### orderAttribs

    public TreeMap orderAttribs

## Constructor Detail

### TaxParametersImpl

    public TaxParametersImpl()

## 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).

### compareTo(Object) Method

    public int compareTo(Object o)

Compare this belonging to another

Overrides
  `BelongingImpl.compareTo(Object)`

#### Parameters

o
  target object for comparision

#### Returns

0 objects are equal

### 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 a deep copy of the entire collection

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

### interfaceName() Method

    public String interfaceName()

interfaceName() returns the unqualified name of the interface from the UML model

#### Returns

the unqualified name of the belonging interface from the UML model

### 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 (deep copy) 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 a (shallow) iterator for this map

### locationMapKeySet() Method

    public Set locationMapKeySet()

Returns a (deep copy) 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 (deep copy) 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).

### setByValue(Belonging) Method

    public void setByValue(Belonging value)

It is possible to call set-by-value with a superclass. If that is the case, only the fields in the superclass will be set in this instance. The remaining fields get the default values.

It is also possible to call set-by-value with a subclass. In this case, the specialized fields in the subclass will be ignored. The overridden fields in the subclass will be populated.

Overrides
  `BelongingImpl.setByValue(Belonging)`

#### Parameters

value
  The `Belonging` to use for initialization.

### setLocationMap(Map) Method

    public void setLocationMap(Map map)

Sets the entire collection

### setOrderAttribs(TreeMap) Method

    public void setOrderAttribs(TreeMap orderAttribs)

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

### value() Method

    public Belonging value()

value() is a more typesafe implementation of clone()

#### Returns

a clone of this instance