oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class TaxTotalType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.TaxTotalType

public class TaxTotalType
extends Object

 <?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: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>
 

Java class for TaxTotalType complex type.

The following schema fragment specifies the expected content contained within this class.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected RoundingAmountType	roundingAmount
protected TaxAmountType	taxAmount
protected TaxEvidenceIndicatorType	taxEvidenceIndicator
protected TaxIncludedIndicatorType	taxIncludedIndicator
protected List<TaxSubtotalType>	taxSubtotal

Constructor Summary

Constructors

Constructor and Description
TaxTotalType()

Method Summary

Modifier and Type	Method and Description
RoundingAmountType	getRoundingAmount() <?
TaxAmountType	getTaxAmount() <?
TaxEvidenceIndicatorType	getTaxEvidenceIndicator() <?
TaxIncludedIndicatorType	getTaxIncludedIndicator() <?
List<TaxSubtotalType>	getTaxSubtotal() <?
void	setRoundingAmount(RoundingAmountType value) Sets the value of the roundingAmount property.
void	setTaxAmount(TaxAmountType value) Sets the value of the taxAmount property.
void	setTaxEvidenceIndicator(TaxEvidenceIndicatorType value) Sets the value of the taxEvidenceIndicator property.
void	setTaxIncludedIndicator(TaxIncludedIndicatorType value) Sets the value of the taxIncludedIndicator property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

taxAmount

protected TaxAmountType taxAmount

roundingAmount

protected RoundingAmountType roundingAmount

taxEvidenceIndicator

protected TaxEvidenceIndicatorType taxEvidenceIndicator

taxIncludedIndicator

protected TaxIncludedIndicatorType taxIncludedIndicator

taxSubtotal

protected List<TaxSubtotalType> taxSubtotal

Constructor Detail

TaxTotalType

public TaxTotalType()

Method Detail

getTaxAmount

public TaxAmountType getTaxAmount()

 <?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: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>
 

Returns:

possible object is TaxAmountType

setTaxAmount

public void setTaxAmount(TaxAmountType value)

Sets the value of the taxAmount property.

Parameters:

value - allowed object is TaxAmountType

getRoundingAmount

public RoundingAmountType getRoundingAmount()

 <?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: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>
 

Returns:

possible object is RoundingAmountType

setRoundingAmount

public void setRoundingAmount(RoundingAmountType value)

Sets the value of the roundingAmount property.

Parameters:

value - allowed object is RoundingAmountType

getTaxEvidenceIndicator

public TaxEvidenceIndicatorType getTaxEvidenceIndicator()

 <?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: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>
 

Returns:

possible object is TaxEvidenceIndicatorType

setTaxEvidenceIndicator

public void setTaxEvidenceIndicator(TaxEvidenceIndicatorType value)

Sets the value of the taxEvidenceIndicator property.

Parameters:

value - allowed object is TaxEvidenceIndicatorType

getTaxIncludedIndicator

public TaxIncludedIndicatorType getTaxIncludedIndicator()

 <?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: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>
 

Returns:

possible object is TaxIncludedIndicatorType

setTaxIncludedIndicator

public void setTaxIncludedIndicator(TaxIncludedIndicatorType value)

Sets the value of the taxIncludedIndicator property.

Parameters:

value - allowed object is TaxIncludedIndicatorType

getTaxSubtotal

public List<TaxSubtotalType> getTaxSubtotal()

 <?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: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>
 

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 set method for the taxSubtotal property.

For example, to add a new item, do as follows:

    getTaxSubtotal().add(newItem);
 

Objects of the following type(s) are allowed in the list TaxSubtotalType