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

public interface TaxInformation
extends `Belonging`

A Tax Information class is used to report the taxes totals for each entity. total is the sum of all children taxlineresult.tax Attribute: total This is the total tax for the order or the line item.

- Containment: By Value
- Multiplicity: 1:1

Attribute: entityTax

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

Related Topics

``TaxInformationHome``
``TaxInformationImpl``

All Known Implementing Classes
  `TaxInformationImpl`

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

## 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 boolean` | `containsEntityTax`(`TaxLineResult` element) Returns true if this collection contains the specified element.
`public boolean` | `containsEntityTaxCollection`(`Collection` c) 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 the entire collection
`public `Price`` | `getTotal`() Get the value of total
`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` | `setEntityTaxCollection`(`Collection` collection) Sets the entire collection
`public void` | `setTotal`(`Price` total) Set the value of total

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

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

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

### containsEntityTax(TaxLineResult) Method

    public boolean containsEntityTax(TaxLineResult element)

Returns true if this collection contains the specified element.

### containsEntityTaxCollection(Collection) Method

    public boolean containsEntityTaxCollection(Collection c)

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 the entire collection

### getTotal() Method

    public Price getTotal()

Get the value of total

#### Returns

total.

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

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