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

Class ConsumptionType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ConsumptionType
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>Consumption. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the consumption of a utility.</ccts:Definition><ccts:ObjectClass>Consumption</ccts:ObjectClass></ccts:Component>
 

Java class for ConsumptionType complex type.

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

 <complexType name="ConsumptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UtilityStatementTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}MainPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AllowanceCharge" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxTotal" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EnergyWaterSupply" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TelecommunicationsSupply" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LegalMonetaryTotal"/>
       </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
ConsumptionType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addAllowanceCharge(AllowanceChargeType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addTaxTotal(TaxTotalType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ConsumptionType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ConsumptionType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<AllowanceChargeType>	getAllowanceCharge() <?
AllowanceChargeType	getAllowanceChargeAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getAllowanceChargeCount() Created by ph-jaxb22-plugin -Xph-list-extension
EnergyWaterSupplyType	getEnergyWaterSupply() <?
MonetaryTotalType	getLegalMonetaryTotal() <?
PeriodType	getMainPeriod() <?
List<TaxTotalType>	getTaxTotal() <?
TaxTotalType	getTaxTotalAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getTaxTotalCount() Created by ph-jaxb22-plugin -Xph-list-extension
TelecommunicationsSupplyType	getTelecommunicationsSupply() <?
UtilityStatementTypeCodeType	getUtilityStatementTypeCode() <?
String	getUtilityStatementTypeCodeValue() Get the value of the contained UtilityStatementTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasAllowanceChargeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoAllowanceChargeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoTaxTotalEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasTaxTotalEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setAllowanceCharge(List<AllowanceChargeType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setEnergyWaterSupply(EnergyWaterSupplyType value) Sets the value of the energyWaterSupply property.
void	setLegalMonetaryTotal(MonetaryTotalType value) Sets the value of the legalMonetaryTotal property.
void	setMainPeriod(PeriodType value) Sets the value of the mainPeriod property.
void	setTaxTotal(List<TaxTotalType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setTelecommunicationsSupply(TelecommunicationsSupplyType value) Sets the value of the telecommunicationsSupply property.
UtilityStatementTypeCodeType	setUtilityStatementTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setUtilityStatementTypeCode(UtilityStatementTypeCodeType value) Sets the value of the utilityStatementTypeCode 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

ConsumptionType

public ConsumptionType()

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

Method Detail

getUtilityStatementTypeCode

@Nullable
public UtilityStatementTypeCodeType getUtilityStatementTypeCode()

 <?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>Consumption. Utility Statement Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code identifying the type of the Utility Statement required for this consumption. Explains the kind of utility the statement is about, e.g.. "gas", "electricity", "telephone"</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTerm>Utility Statement Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>Electricity</ccts:Examples></ccts:Component>
 

Returns:

possible object is UtilityStatementTypeCodeType

setUtilityStatementTypeCode

public void setUtilityStatementTypeCode(@Nullable
                                        UtilityStatementTypeCodeType value)

Sets the value of the utilityStatementTypeCode property.

Parameters:

value - allowed object is UtilityStatementTypeCodeType

getMainPeriod

@Nullable
public PeriodType getMainPeriod()

 <?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>Consumption. Main_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period of consumption.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTermQualifier>Main</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setMainPeriod

public void setMainPeriod(@Nullable
                          PeriodType value)

Sets the value of the mainPeriod property.

Parameters:

value - allowed object is PeriodType

getAllowanceCharge

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<AllowanceChargeType> getAllowanceCharge()

 <?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>Consumption. Allowance Charge</ccts:DictionaryEntryName><ccts:Definition>An allowance or charges that may apply with this consumption.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTerm>Allowance Charge</ccts:PropertyTerm><ccts:AssociatedObjectClass>Allowance Charge</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Allowance Charge</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getAllowanceCharge().add(newItem);
 

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

getTaxTotal

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TaxTotalType> getTaxTotal()

 <?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>Consumption. Tax Total</ccts:DictionaryEntryName><ccts:Definition>The total of taxes for each tax type covering the consumption.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTerm>Tax Total</ccts:PropertyTerm><ccts:AssociatedObjectClass>Tax Total</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Tax Total</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getTaxTotal().add(newItem);
 

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

getEnergyWaterSupply

@Nullable
public EnergyWaterSupplyType getEnergyWaterSupply()

 <?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>Consumption. Energy Water Supply</ccts:DictionaryEntryName><ccts:Definition>The details of any energy or water consumption.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTerm>Energy Water Supply</ccts:PropertyTerm><ccts:AssociatedObjectClass>Energy Water Supply</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Energy Water Supply</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is EnergyWaterSupplyType

setEnergyWaterSupply

public void setEnergyWaterSupply(@Nullable
                                 EnergyWaterSupplyType value)

Sets the value of the energyWaterSupply property.

Parameters:

value - allowed object is EnergyWaterSupplyType

getTelecommunicationsSupply

@Nullable
public TelecommunicationsSupplyType getTelecommunicationsSupply()

 <?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>Consumption. Telecommunications Supply</ccts:DictionaryEntryName><ccts:Definition>The details of any telecommunications consumption.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTerm>Telecommunications Supply</ccts:PropertyTerm><ccts:AssociatedObjectClass>Telecommunications Supply</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Telecommunications Supply</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is TelecommunicationsSupplyType

setTelecommunicationsSupply

public void setTelecommunicationsSupply(@Nullable
                                        TelecommunicationsSupplyType value)

Sets the value of the telecommunicationsSupply property.

Parameters:

value - allowed object is TelecommunicationsSupplyType

getLegalMonetaryTotal

@Nullable
public MonetaryTotalType getLegalMonetaryTotal()

 <?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>Consumption. Legal_ Monetary Total. Monetary Total</ccts:DictionaryEntryName><ccts:Definition>The total amount payable on this consumption, including any allowances, charges, or taxes.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption</ccts:ObjectClass><ccts:PropertyTermQualifier>Legal</ccts:PropertyTermQualifier><ccts:PropertyTerm>Monetary Total</ccts:PropertyTerm><ccts:AssociatedObjectClass>Monetary Total</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Monetary Total</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is MonetaryTotalType

setLegalMonetaryTotal

public void setLegalMonetaryTotal(@Nullable
                                  MonetaryTotalType value)

Sets the value of the legalMonetaryTotal property.

Parameters:

value - allowed object is MonetaryTotalType

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

setAllowanceCharge

public void setAllowanceCharge(@Nullable
                               List<AllowanceChargeType> aList)

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

Parameters:

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

setTaxTotal

public void setTaxTotal(@Nullable
                        List<TaxTotalType> aList)

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

Parameters:

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

hasAllowanceChargeEntries

public boolean hasAllowanceChargeEntries()

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

Returns:

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

hasNoAllowanceChargeEntries

public boolean hasNoAllowanceChargeEntries()

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

Returns:

true if no item is contained, false otherwise.

getAllowanceChargeCount

@Nonnegative
public int getAllowanceChargeCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getAllowanceChargeAtIndex

@Nullable
public AllowanceChargeType getAllowanceChargeAtIndex(@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!

addAllowanceCharge

public void addAllowanceCharge(@Nonnull
                               AllowanceChargeType elem)

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

Parameters:

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

hasTaxTotalEntries

public boolean hasTaxTotalEntries()

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

Returns:

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

hasNoTaxTotalEntries

public boolean hasNoTaxTotalEntries()

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

Returns:

true if no item is contained, false otherwise.

getTaxTotalCount

@Nonnegative
public int getTaxTotalCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getTaxTotalAtIndex

@Nullable
public TaxTotalType getTaxTotalAtIndex(@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!

addTaxTotal

public void addTaxTotal(@Nonnull
                        TaxTotalType 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
                    ConsumptionType 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 ConsumptionType 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.

setUtilityStatementTypeCode

@Nonnull
public UtilityStatementTypeCodeType setUtilityStatementTypeCode(@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 UtilityStatementTypeCodeType and never null

getUtilityStatementTypeCodeValue

@Nullable
public String getUtilityStatementTypeCodeValue()

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

Returns:

Either the value of the contained UtilityStatementTypeCodeType object or null