TaxTotalType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.TaxTotalType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class TaxTotalType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the total tax for a particular taxation scheme.</ccts:Definition><ccts:ObjectClass>Tax Total</ccts:ObjectClass></ccts:Component> </pre> Java class for TaxTotalType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="TaxTotalType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxAmount"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}RoundingAmount" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxEvidenceIndicator" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxIncludedIndicator" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxSubtotal" maxOccurs="unbounded" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-list-extension This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TaxTotalType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`TaxTotalType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTaxSubtotal(TaxSubtotalType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`TaxTotalType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(TaxTotalType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`RoundingAmountType`	`getRoundingAmount()` <pre> <?
`BigDecimal`	`getRoundingAmountValue()` Get the value of the contained RoundingAmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`TaxAmountType`	`getTaxAmount()` <pre> <?
`BigDecimal`	`getTaxAmountValue()` Get the value of the contained TaxAmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`TaxEvidenceIndicatorType`	`getTaxEvidenceIndicator()` <pre> <?
`TaxIncludedIndicatorType`	`getTaxIncludedIndicator()` <pre> <?
`List<TaxSubtotalType>`	`getTaxSubtotal()` <pre> <?
`TaxSubtotalType`	`getTaxSubtotalAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getTaxSubtotalCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoTaxSubtotalEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasTaxSubtotalEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`isTaxEvidenceIndicatorValue(boolean nullValue)` Get the value of the contained TaxEvidenceIndicatorType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`boolean`	`isTaxIncludedIndicatorValue(boolean nullValue)` Get the value of the contained TaxIncludedIndicatorType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`RoundingAmountType`	`setRoundingAmount(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setRoundingAmount(RoundingAmountType value)` Sets the value of the roundingAmount property.
`TaxAmountType`	`setTaxAmount(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setTaxAmount(TaxAmountType value)` Sets the value of the taxAmount property.
`TaxEvidenceIndicatorType`	`setTaxEvidenceIndicator(boolean valueParam)` Special setter with value of type boolean<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setTaxEvidenceIndicator(TaxEvidenceIndicatorType value)` Sets the value of the taxEvidenceIndicator property.
`TaxIncludedIndicatorType`	`setTaxIncludedIndicator(boolean valueParam)` Special setter with value of type boolean<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setTaxIncludedIndicator(TaxIncludedIndicatorType value)` Sets the value of the taxIncludedIndicator property.
`void`	`setTaxSubtotal(List<TaxSubtotalType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - TaxTotalType
```
public TaxTotalType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getTaxAmount
```
@Nullable
public TaxAmountType getTaxAmount()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Tax Amount. Amount</ccts:DictionaryEntryName><ccts:Definition>The total tax amount for a particular taxation scheme, e.g., VAT; the sum of the tax subtotals for each tax category within the taxation scheme.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Tax Total</ccts:ObjectClass><ccts:PropertyTerm>Tax Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is TaxAmountType
 - setTaxAmount
```
public void setTaxAmount(@Nullable
 TaxAmountType value)
```
 Sets the value of the taxAmount property.
 
 Parameters:
 
 value - allowed object is TaxAmountType
 - getRoundingAmount
```
@Nullable
public RoundingAmountType getRoundingAmount()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Rounding Amount. Amount</ccts:DictionaryEntryName><ccts:Definition>The rounding amount (positive or negative) added to the calculated tax total to produce the rounded TaxAmount.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Total</ccts:ObjectClass><ccts:PropertyTerm>Rounding Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is RoundingAmountType
 - setRoundingAmount
```
public void setRoundingAmount(@Nullable
 RoundingAmountType value)
```
 Sets the value of the roundingAmount property.
 
 Parameters:
 
 value - allowed object is RoundingAmountType
 - getTaxEvidenceIndicator
```
@Nullable
public TaxEvidenceIndicatorType getTaxEvidenceIndicator()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Tax Evidence_ Indicator. Indicator</ccts:DictionaryEntryName><ccts:Definition>An indicator that this total is recognized as legal evidence for taxation purposes (true) or not (false).</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Total</ccts:ObjectClass><ccts:PropertyTermQualifier>Tax Evidence</ccts:PropertyTermQualifier><ccts:PropertyTerm>Indicator</ccts:PropertyTerm><ccts:RepresentationTerm>Indicator</ccts:RepresentationTerm><ccts:DataType>Indicator. Type</ccts:DataType><ccts:Examples>default is negative</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is TaxEvidenceIndicatorType
 - setTaxEvidenceIndicator
```
public void setTaxEvidenceIndicator(@Nullable
 TaxEvidenceIndicatorType value)
```
 Sets the value of the taxEvidenceIndicator property.
 
 Parameters:
 
 value - allowed object is TaxEvidenceIndicatorType
 - getTaxIncludedIndicator
```
@Nullable
public TaxIncludedIndicatorType getTaxIncludedIndicator()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Tax Included_ Indicator. Indicator</ccts:DictionaryEntryName><ccts:Definition>An indicator that tax is included in the calculation (true) or not (false).</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Total</ccts:ObjectClass><ccts:PropertyTermQualifier>Tax Included</ccts:PropertyTermQualifier><ccts:PropertyTerm>Indicator</ccts:PropertyTerm><ccts:RepresentationTerm>Indicator</ccts:RepresentationTerm><ccts:DataType>Indicator. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is TaxIncludedIndicatorType
 - setTaxIncludedIndicator
```
public void setTaxIncludedIndicator(@Nullable
 TaxIncludedIndicatorType value)
```
 Sets the value of the taxIncludedIndicator property.
 
 Parameters:
 
 value - allowed object is TaxIncludedIndicatorType
 - getTaxSubtotal
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TaxSubtotalType> getTaxSubtotal()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Tax Total. Tax Subtotal</ccts:DictionaryEntryName><ccts:Definition>One of the subtotals the sum of which equals the total tax amount for a particular taxation scheme.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Tax Total</ccts:ObjectClass><ccts:PropertyTerm>Tax Subtotal</ccts:PropertyTerm><ccts:AssociatedObjectClass>Tax Subtotal</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Tax Subtotal</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the taxSubtotal property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the taxSubtotal property. For example, to add a new item, do as follows: <pre> getTaxSubtotal().add(newItem); </pre> Objects of the following type(s) are allowed in the list TaxSubtotalType
 - equals
```
public boolean equals(Object o)
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Created by ph-jaxb22-plugin -Xph-tostring
 
 Overrides:
 
 toString in class Object
 - setTaxSubtotal
```
public void setTaxSubtotal(@Nullable
 List<TaxSubtotalType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasTaxSubtotalEntries
```
public boolean hasTaxSubtotalEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoTaxSubtotalEntries
```
public boolean hasNoTaxSubtotalEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getTaxSubtotalCount
```
@Nonnegative
public int getTaxSubtotalCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getTaxSubtotalAtIndex
```
@Nullable
public TaxSubtotalType getTaxSubtotalAtIndex(@Nonnegative
 int index)
 throws IndexOutOfBoundsException
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 index - The index to retrieve
 
 Returns:
 
 The element at the specified index. May be <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addTaxSubtotal
```
public void addTaxSubtotal(@Nonnull
 TaxSubtotalType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 TaxTotalType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public TaxTotalType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.
 - setTaxAmount
```
@Nonnull
public TaxAmountType setTaxAmount(@Nullable
 BigDecimal valueParam)
```
 Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type TaxAmountType and never <code>null</code>
 - setRoundingAmount
```
@Nonnull
public RoundingAmountType setRoundingAmount(@Nullable
 BigDecimal valueParam)
```
 Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type RoundingAmountType and never <code>null</code>
 - setTaxEvidenceIndicator
```
@Nonnull
public TaxEvidenceIndicatorType setTaxEvidenceIndicator(boolean valueParam)
```
 Special setter with value of type boolean Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set.
 
 Returns:
 
 The created intermediary object of type TaxEvidenceIndicatorType and never <code>null</code>
 - setTaxIncludedIndicator
```
@Nonnull
public TaxIncludedIndicatorType setTaxIncludedIndicator(boolean valueParam)
```
 Special setter with value of type boolean Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set.
 
 Returns:
 
 The created intermediary object of type TaxIncludedIndicatorType and never <code>null</code>
 - getTaxAmountValue
```
@Nullable
public BigDecimal getTaxAmountValue()
```
 Get the value of the contained TaxAmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained TaxAmountType object or <code>null</code>
 - getRoundingAmountValue
```
@Nullable
public BigDecimal getRoundingAmountValue()
```
 Get the value of the contained RoundingAmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained RoundingAmountType object or <code>null</code>
 - isTaxEvidenceIndicatorValue
```
public boolean isTaxEvidenceIndicatorValue(boolean nullValue)
```
 Get the value of the contained TaxEvidenceIndicatorType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 nullValue - The value to be returned, if the owning object is <code>null</code>
 
 Returns:
 
 Either the value of the contained TaxEvidenceIndicatorType object or the passed nullValue
 - isTaxIncludedIndicatorValue
```
public boolean isTaxIncludedIndicatorValue(boolean nullValue)
```
 Get the value of the contained TaxIncludedIndicatorType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 nullValue - The value to be returned, if the owning object is <code>null</code>
 
 Returns:
 
 Either the value of the contained TaxIncludedIndicatorType object or the passed nullValue

Class TaxTotalType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaxTotalType

Method Detail

getTaxAmount

setTaxAmount

getRoundingAmount

setRoundingAmount

getTaxEvidenceIndicator

setTaxEvidenceIndicator

getTaxIncludedIndicator

setTaxIncludedIndicator

getTaxSubtotal

equals

hashCode

toString

setTaxSubtotal

hasTaxSubtotalEntries

hasNoTaxSubtotalEntries

getTaxSubtotalCount

getTaxSubtotalAtIndex

addTaxSubtotal

cloneTo

clone

setTaxAmount

setRoundingAmount

setTaxEvidenceIndicator

setTaxIncludedIndicator

getTaxAmountValue

getRoundingAmountValue

isTaxEvidenceIndicatorValue

isTaxIncludedIndicatorValue