Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

    java.lang.Object
      com.beasys.commerce.foundation.BelongingImpl
          com.beasys.commerce.ebusiness.tax.TaxInformationImpl

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

public class TaxInformationImpl
extends BelongingImpl
implements TaxInformation, Cloneable

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

See Also:
  `TaxInformation`, `TaxInformationHome`, Serialized Form

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

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

Constructor Summary
`TaxInformationImpl()`

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

Methods inherited from class 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 inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.beasys.commerce.foundation.Belonging
`clone, equals`

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

    public boolean addEntityTax(TaxLineResult element)

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

  Specified by:
    `addEntityTax` in interface `TaxInformation`

### addEntityTaxCollection

    public boolean addEntityTaxCollection(Collection collection)

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

  Specified by:
    `addEntityTaxCollection` in interface `TaxInformation`

### clearEntityTaxCollection

    public void clearEntityTaxCollection()

  Removes all of the elements from this collection (optional operation).

  Specified by:
    `clearEntityTaxCollection` in interface `TaxInformation`

### compareTo

    public int compareTo(Object o)

  Compare this belonging to another

  Specified by:
    `compareTo` in interface `Comparable`
  Specified by:
    `compareTo` in class `BelongingImpl`
  Parameters:
    `o` - target object for comparision
  Returns:
    0 objects are equal

### containsEntityTax

    public boolean containsEntityTax(TaxLineResult element)

  Returns true if this collection contains the specified element.

  Specified by:
    `containsEntityTax` in interface `TaxInformation`

### containsEntityTaxCollection

    public boolean containsEntityTaxCollection(Collection collection)

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

  Specified by:
    `containsEntityTaxCollection` in interface `TaxInformation`

### entityTaxCollectionHashCode

    public int entityTaxCollectionHashCode()

  Returns the hash code value for this collection.

  Specified by:
    `entityTaxCollectionHashCode` in interface `TaxInformation`

### entityTaxCollectionIterator

    public Iterator entityTaxCollectionIterator()

  Returns an iterator over the elements in this collection.

  Specified by:
    `entityTaxCollectionIterator` in interface `TaxInformation`

### entityTaxCollectionSize

    public int entityTaxCollectionSize()

  Returns the number of elements in this collection.

  Specified by:
    `entityTaxCollectionSize` in interface `TaxInformation`

### equalsEntityTaxCollection

    public boolean equalsEntityTaxCollection(Object object)

  Compares the specified object with this collection for equality.

  Specified by:
    `equalsEntityTaxCollection` in interface `TaxInformation`

### getEntityTaxCollection

    public Collection getEntityTaxCollection()

  Returns a deep copy of the entire collection

  Specified by:
    `getEntityTaxCollection` in interface `TaxInformation`

### getTotal

    public Price getTotal()

  Get the value of total

  Specified by:
    `getTotal` in interface `TaxInformation`
  Returns:
    total.

### interfaceName

    public String interfaceName()

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

  Specified by:
    `interfaceName` in interface `Belonging`
  Returns:
    the unqualified name of the belonging interface from the UML model

### isEntityTaxCollectionEmpty

    public boolean isEntityTaxCollectionEmpty()

  Returns true if this collection contains no elements.

  Specified by:
    `isEntityTaxCollectionEmpty` in interface `TaxInformation`

### removeEntityTax

    public boolean removeEntityTax(TaxLineResult element)

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

  Specified by:
    `removeEntityTax` in interface `TaxInformation`

### removeEntityTaxCollection

    public boolean removeEntityTaxCollection(Collection collection)

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

  Specified by:
    `removeEntityTaxCollection` in interface `TaxInformation`

### retainEntityTaxCollection

    public boolean retainEntityTaxCollection(Collection collection)

  Retains only the elements in this collection that are contained in the specified collection (optional operation).

  Specified by:
    `retainEntityTaxCollection` in interface `TaxInformation`

### setByValue

    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.

  Specified by:
    `setByValue` in interface `Belonging`
  Overrides:
    `setByValue` in class `BelongingImpl`
  Parameters:
    `value` - The `Belonging` to use for initialization.

### setEntityTaxCollection

    public void setEntityTaxCollection(Collection collection)

  Sets the entire collection

  Specified by:
    `setEntityTaxCollection` in interface `TaxInformation`

### setTotal

    public void setTotal(Price total)

  Set the value of total

  Specified by:
    `setTotal` in interface `TaxInformation`
  Parameters:
    `total` - total to be added

### value

    public Belonging value()

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

  Specified by:
    `value` in interface `Belonging`
  Returns:
    a clone of this instance

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004 BEA Systems, Inc. All Rights Reserved