oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class TaxSchemeType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.TaxSchemeType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class TaxSchemeType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?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 Scheme. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a taxation scheme (e.g., VAT, State tax, County tax).</ccts:Definition><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass></ccts:Component>
 

Java class for TaxSchemeType complex type.

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

 <complexType name="TaxSchemeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CurrencyCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}JurisdictionRegionAddress" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

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
TaxSchemeType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addJurisdictionRegionAddress(AddressType elem) Created by ph-jaxb22-plugin -Xph-list-extension
TaxSchemeType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(TaxSchemeType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
CurrencyCodeType	getCurrencyCode() <?
String	getCurrencyCodeValue() Get the value of the contained CurrencyCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<AddressType>	getJurisdictionRegionAddress() <?
AddressType	getJurisdictionRegionAddressAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getJurisdictionRegionAddressCount() Created by ph-jaxb22-plugin -Xph-list-extension
NameType	getName() <?
String	getNameValue() Get the value of the contained NameType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
TaxTypeCodeType	getTaxTypeCode() <?
String	getTaxTypeCodeValue() Get the value of the contained TaxTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasJurisdictionRegionAddressEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoJurisdictionRegionAddressEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setCurrencyCode(CurrencyCodeType value) Sets the value of the currencyCode property.
CurrencyCodeType	setCurrencyCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setID(IDType value) Sets the value of the id property.
IDType	setID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setJurisdictionRegionAddress(List<AddressType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setName(NameType value) Sets the value of the name property.
NameType	setName(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
TaxTypeCodeType	setTaxTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setTaxTypeCode(TaxTypeCodeType value) Sets the value of the taxTypeCode property.
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

TaxSchemeType

public TaxSchemeType()

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

Method Detail

getID

@Nullable
public IDType getID()

 <?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 Scheme. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this taxation scheme.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>http://www.unece.org/uncefact/codelist/standard/EDIFICASEU_TaxExemptionReason_D09B.xsd</ccts:Examples></ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(@Nullable
                  IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getName

@Nullable
public NameType getName()

 <?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 Scheme. Name</ccts:DictionaryEntryName><ccts:Definition>The name of this taxation scheme.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass><ccts:PropertyTerm>Name</ccts:PropertyTerm><ccts:RepresentationTerm>Name</ccts:RepresentationTerm><ccts:DataType>Name. Type</ccts:DataType><ccts:Examples>Value Added Tax , Wholesale Tax , Sales Tax , State Tax </ccts:Examples></ccts:Component>
 

Returns:

possible object is NameType

setName

public void setName(@Nullable
                    NameType value)

Sets the value of the name property.

Parameters:

value - allowed object is NameType

getTaxTypeCode

@Nullable
public TaxTypeCodeType getTaxTypeCode()

 <?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 Scheme. Tax Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of tax.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass><ccts:PropertyTerm>Tax Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>Consumption , Sales </ccts:Examples></ccts:Component>
 

Returns:

possible object is TaxTypeCodeType

setTaxTypeCode

public void setTaxTypeCode(@Nullable
                           TaxTypeCodeType value)

Sets the value of the taxTypeCode property.

Parameters:

value - allowed object is TaxTypeCodeType

getCurrencyCode

@Nullable
public CurrencyCodeType getCurrencyCode()

 <?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 Scheme. Currency Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the currency in which the tax is collected and reported.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass><ccts:PropertyTerm>Currency Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataTypeQualifier>Currency</ccts:DataTypeQualifier><ccts:DataType>Currency_ Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is CurrencyCodeType

setCurrencyCode

public void setCurrencyCode(@Nullable
                            CurrencyCodeType value)

Sets the value of the currencyCode property.

Parameters:

value - allowed object is CurrencyCodeType

getJurisdictionRegionAddress

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<AddressType> getJurisdictionRegionAddress()

 <?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 Scheme. Jurisdiction Region_ Address. Address</ccts:DictionaryEntryName><ccts:Definition>A geographic area in which this taxation scheme applies.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Tax Scheme</ccts:ObjectClass><ccts:PropertyTermQualifier>Jurisdiction Region</ccts:PropertyTermQualifier><ccts:PropertyTerm>Address</ccts:PropertyTerm><ccts:AssociatedObjectClass>Address</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Address</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the jurisdictionRegionAddress 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 jurisdictionRegionAddress property.

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

    getJurisdictionRegionAddress().add(newItem);
 

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

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

setJurisdictionRegionAddress

public void setJurisdictionRegionAddress(@Nullable
                                         List<AddressType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasJurisdictionRegionAddressEntries

public boolean hasJurisdictionRegionAddressEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoJurisdictionRegionAddressEntries

public boolean hasNoJurisdictionRegionAddressEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getJurisdictionRegionAddressCount

@Nonnegative
public int getJurisdictionRegionAddressCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getJurisdictionRegionAddressAtIndex

@Nullable
public AddressType getJurisdictionRegionAddressAtIndex(@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 null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addJurisdictionRegionAddress

public void addJurisdictionRegionAddress(@Nonnull
                                         AddressType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    TaxSchemeType ret)

This method clones all values from this 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 null.

clone

@Nonnull
 @ReturnsMutableCopy
public TaxSchemeType 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 null.

setTaxTypeCode

@Nonnull
public TaxTypeCodeType setTaxTypeCode(@Nullable
                                                String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type TaxTypeCodeType and never null

setCurrencyCode

@Nonnull
public CurrencyCodeType setCurrencyCode(@Nullable
                                                  String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type CurrencyCodeType and never null

setID

@Nonnull
public IDType setID(@Nullable
                              String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type IDType and never null

setName

@Nonnull
public NameType setName(@Nullable
                                  String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type NameType and never null

getIDValue

@Nullable
public String getIDValue()

Get the value of the contained IDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained IDType object or null

getNameValue

@Nullable
public String getNameValue()

Get the value of the contained NameType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained NameType object or null

getTaxTypeCodeValue

@Nullable
public String getTaxTypeCodeValue()

Get the value of the contained TaxTypeCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained TaxTypeCodeType object or null

getCurrencyCodeValue

@Nullable
public String getCurrencyCodeValue()

Get the value of the contained CurrencyCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained CurrencyCodeType object or null