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

public class TaxInformationImpl
extends `BelongingImpl`
implements `Cloneable`, `TaxInformation`

A Tax Information class is used to report the taxes totals for each entity. total is the sum of all children taxlineresult.tax

Related Topics

``TaxInformation``
``TaxInformationHome``

Hierarchy
  `Object`
  `BelongingImpl`
  `TaxInformationImpl`

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

## Field Summary

`public `Collection`` | `entityTax` Containment: By Value Multiplicity: 0:N Interface: java.util.Collection
`public `Price`` | `total` This is the total tax for the order or the line item.

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

## Constructor Summary

TaxInformationImpl()

## Method Summary

`public boolean` | `addEntityTax`(`TaxLineResult` element) Ensures that this collection contains the specified element (optional operation).
`public boolean` | `addEntityTaxCollection`(`Collection` collection) Adds all of the elements in the specified collection to this collection (optional operation).
`public void` | `clearEntityTaxCollection`() Removes all of the elements from this collection (optional operation).
`public int` | `compareTo`(`Object` o) Compare this belonging to another
`public boolean` | `containsEntityTax`(`TaxLineResult` element) Returns true if this collection contains the specified element.
`public boolean` | `containsEntityTaxCollection`(`Collection` collection) Returns true if this collection contains all of the elements in the specified collection.
`public int` | `entityTaxCollectionHashCode`() Returns the hash code value for this collection.
`public `Iterator`` | `entityTaxCollectionIterator`() Returns an iterator over the elements in this collection.
`public int` | `entityTaxCollectionSize`() Returns the number of elements in this collection.
`public boolean` | `equalsEntityTaxCollection`(`Object` object) Compares the specified object with this collection for equality.
`public `Collection`` | `getEntityTaxCollection`() Returns a deep copy of the entire collection
`public `Price`` | `getTotal`() Get the value of total
`public `String`` | `interfaceName`() interfaceName() returns the unqualified name of the interface from the UML model
`public boolean` | `isEntityTaxCollectionEmpty`() Returns true if this collection contains no elements.
`public boolean` | `removeEntityTax`(`TaxLineResult` element) Removes a single instance of the specified element from this collection, if it is present (optional operation).
`public boolean` | `removeEntityTaxCollection`(`Collection` collection) Removes all this collection's elements that are also contained in the specified collection (optional operation).
`public boolean` | `retainEntityTaxCollection`(`Collection` collection) Retains only the elements in this collection that are contained in the specified collection (optional operation).
`public void` | `setByValue`(`Belonging` value) It is possible to call set-by-value with a superclass.
`public void` | `setEntityTaxCollection`(`Collection` collection) Sets the entire collection
`public void` | `setTotal`(`Price` total) Set the value of total
`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.`TaxInformation``
``addEntityTax`, `addEntityTaxCollection`, `clearEntityTaxCollection`, `containsEntityTax`, `containsEntityTaxCollection`, `entityTaxCollectionHashCode`, `entityTaxCollectionIterator`, `entityTaxCollectionSize`, `equalsEntityTaxCollection`, `getEntityTaxCollection`, `getTotal`, `isEntityTaxCollectionEmpty`, `removeEntityTax`, `removeEntityTaxCollection`, `retainEntityTaxCollection`, `setEntityTaxCollection`, `setTotal``

## Field Detail

### entityTax

    public Collection entityTax

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

### total

    public Price total

  This is the total tax for the order or the line item.
  - Containment: By Value
  - Multiplicity: 1:1

## Constructor Detail

### TaxInformationImpl

    public TaxInformationImpl()

## Method Detail

### addEntityTax(TaxLineResult) Method

    public boolean addEntityTax(TaxLineResult element)

Ensures that this collection contains the specified element (optional operation).

### addEntityTaxCollection(Collection) Method

    public boolean addEntityTaxCollection(Collection collection)

Adds all of the elements in the specified collection to this collection (optional operation).

### clearEntityTaxCollection() Method

    public void clearEntityTaxCollection()

Removes all of the elements from this collection (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

### containsEntityTax(TaxLineResult) Method

    public boolean containsEntityTax(TaxLineResult element)

Returns true if this collection contains the specified element.

### containsEntityTaxCollection(Collection) Method

    public boolean containsEntityTaxCollection(Collection collection)

Returns true if this collection contains all of the elements in the specified collection.

### entityTaxCollectionHashCode() Method

    public int entityTaxCollectionHashCode()

Returns the hash code value for this collection.

### entityTaxCollectionIterator() Method

    public Iterator entityTaxCollectionIterator()

Returns an iterator over the elements in this collection.

### entityTaxCollectionSize() Method

    public int entityTaxCollectionSize()

Returns the number of elements in this collection.

### equalsEntityTaxCollection(Object) Method

    public boolean equalsEntityTaxCollection(Object object)

Compares the specified object with this collection for equality.

### getEntityTaxCollection() Method

    public Collection getEntityTaxCollection()

Returns a deep copy of the entire collection

### getTotal() Method

    public Price getTotal()

Get the value of total

#### Returns

total.

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

### isEntityTaxCollectionEmpty() Method

    public boolean isEntityTaxCollectionEmpty()

Returns true if this collection contains no elements.

### removeEntityTax(TaxLineResult) Method

    public boolean removeEntityTax(TaxLineResult element)

Removes a single instance of the specified element from this collection, if it is present (optional operation).

### removeEntityTaxCollection(Collection) Method

    public boolean removeEntityTaxCollection(Collection collection)

Removes all this collection's elements that are also contained in the specified collection (optional operation).

### retainEntityTaxCollection(Collection) Method

    public boolean retainEntityTaxCollection(Collection collection)

Retains only the elements in this collection that are contained in the specified collection (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.

### setEntityTaxCollection(Collection) Method

    public void setEntityTaxCollection(Collection collection)

Sets the entire collection

### setTotal(Price) Method

    public void setTotal(Price total)

Set the value of total

#### Parameters

total
  total to be added

### value() Method

    public Belonging value()

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

#### Returns

a clone of this instance