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

Class EnergyWaterSupplyType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class EnergyWaterSupplyType
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>Energy Water Supply. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the supply (and therefore consumption) of an amount of energy or water.</ccts:Definition><ccts:ObjectClass>Energy Water Supply</ccts:ObjectClass></ccts:Component>
 

Java class for EnergyWaterSupplyType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addConsumptionAverage(ConsumptionAverageType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addConsumptionReport(ConsumptionReportType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addEnergyTaxReport(EnergyTaxReportType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addEnergyWaterConsumptionCorrection(ConsumptionCorrectionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
EnergyWaterSupplyType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(EnergyWaterSupplyType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<ConsumptionAverageType>	getConsumptionAverage() <?
ConsumptionAverageType	getConsumptionAverageAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getConsumptionAverageCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<ConsumptionReportType>	getConsumptionReport() <?
ConsumptionReportType	getConsumptionReportAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getConsumptionReportCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<EnergyTaxReportType>	getEnergyTaxReport() <?
EnergyTaxReportType	getEnergyTaxReportAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getEnergyTaxReportCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<ConsumptionCorrectionType>	getEnergyWaterConsumptionCorrection() <?
ConsumptionCorrectionType	getEnergyWaterConsumptionCorrectionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getEnergyWaterConsumptionCorrectionCount() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasConsumptionAverageEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasConsumptionReportEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasEnergyTaxReportEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasEnergyWaterConsumptionCorrectionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoConsumptionAverageEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoConsumptionReportEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoEnergyTaxReportEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoEnergyWaterConsumptionCorrectionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setConsumptionAverage(List<ConsumptionAverageType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setConsumptionReport(List<ConsumptionReportType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setEnergyTaxReport(List<EnergyTaxReportType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setEnergyWaterConsumptionCorrection(List<ConsumptionCorrectionType> 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

EnergyWaterSupplyType

public EnergyWaterSupplyType()

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

Method Detail

getConsumptionReport

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ConsumptionReportType> getConsumptionReport()

 <?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>Energy Water Supply. Consumption Report</ccts:DictionaryEntryName><ccts:Definition>An amount of energy or water consumed.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Energy Water Supply</ccts:ObjectClass><ccts:PropertyTerm>Consumption Report</ccts:PropertyTerm><ccts:AssociatedObjectClass>Consumption Report</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Consumption Report</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getConsumptionReport().add(newItem);
 

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

getEnergyTaxReport

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<EnergyTaxReportType> getEnergyTaxReport()

 <?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>Energy Water Supply. Energy Tax Report</ccts:DictionaryEntryName><ccts:Definition>A tax on the consumption of energy or water.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Energy Water Supply</ccts:ObjectClass><ccts:PropertyTerm>Energy Tax Report</ccts:PropertyTerm><ccts:AssociatedObjectClass>Energy Tax Report</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Energy Tax Report</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getEnergyTaxReport().add(newItem);
 

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

getConsumptionAverage

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ConsumptionAverageType> getConsumptionAverage()

 <?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>Energy Water Supply. Consumption Average</ccts:DictionaryEntryName><ccts:Definition>A consumption average.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Energy Water Supply</ccts:ObjectClass><ccts:PropertyTerm>Consumption Average</ccts:PropertyTerm><ccts:AssociatedObjectClass>Consumption Average</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Consumption Average</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getConsumptionAverage().add(newItem);
 

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

getEnergyWaterConsumptionCorrection

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ConsumptionCorrectionType> getEnergyWaterConsumptionCorrection()

 <?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>Energy Water Supply. Energy Water_ Consumption Correction. Consumption Correction</ccts:DictionaryEntryName><ccts:Definition>Describes any corrections or adjustments to the supply of energy or water.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Energy Water Supply</ccts:ObjectClass><ccts:PropertyTermQualifier>Energy Water</ccts:PropertyTermQualifier><ccts:PropertyTerm>Consumption Correction</ccts:PropertyTerm><ccts:AssociatedObjectClass>Consumption Correction</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Consumption Correction</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getEnergyWaterConsumptionCorrection().add(newItem);
 

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

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

setConsumptionReport

public void setConsumptionReport(@Nullable
                                 List<ConsumptionReportType> aList)

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

Parameters:

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

setEnergyTaxReport

public void setEnergyTaxReport(@Nullable
                               List<EnergyTaxReportType> aList)

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

Parameters:

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

setConsumptionAverage

public void setConsumptionAverage(@Nullable
                                  List<ConsumptionAverageType> aList)

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

Parameters:

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

setEnergyWaterConsumptionCorrection

public void setEnergyWaterConsumptionCorrection(@Nullable
                                                List<ConsumptionCorrectionType> aList)

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

Parameters:

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

hasConsumptionReportEntries

public boolean hasConsumptionReportEntries()

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

Returns:

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

hasNoConsumptionReportEntries

public boolean hasNoConsumptionReportEntries()

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

Returns:

true if no item is contained, false otherwise.

getConsumptionReportCount

@Nonnegative
public int getConsumptionReportCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getConsumptionReportAtIndex

@Nullable
public ConsumptionReportType getConsumptionReportAtIndex(@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!

addConsumptionReport

public void addConsumptionReport(@Nonnull
                                 ConsumptionReportType elem)

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

Parameters:

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

hasEnergyTaxReportEntries

public boolean hasEnergyTaxReportEntries()

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

Returns:

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

hasNoEnergyTaxReportEntries

public boolean hasNoEnergyTaxReportEntries()

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

Returns:

true if no item is contained, false otherwise.

getEnergyTaxReportCount

@Nonnegative
public int getEnergyTaxReportCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getEnergyTaxReportAtIndex

@Nullable
public EnergyTaxReportType getEnergyTaxReportAtIndex(@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!

addEnergyTaxReport

public void addEnergyTaxReport(@Nonnull
                               EnergyTaxReportType elem)

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

Parameters:

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

hasConsumptionAverageEntries

public boolean hasConsumptionAverageEntries()

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

Returns:

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

hasNoConsumptionAverageEntries

public boolean hasNoConsumptionAverageEntries()

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

Returns:

true if no item is contained, false otherwise.

getConsumptionAverageCount

@Nonnegative
public int getConsumptionAverageCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getConsumptionAverageAtIndex

@Nullable
public ConsumptionAverageType getConsumptionAverageAtIndex(@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!

addConsumptionAverage

public void addConsumptionAverage(@Nonnull
                                  ConsumptionAverageType elem)

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

Parameters:

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

hasEnergyWaterConsumptionCorrectionEntries

public boolean hasEnergyWaterConsumptionCorrectionEntries()

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

Returns:

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

hasNoEnergyWaterConsumptionCorrectionEntries

public boolean hasNoEnergyWaterConsumptionCorrectionEntries()

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

Returns:

true if no item is contained, false otherwise.

getEnergyWaterConsumptionCorrectionCount

@Nonnegative
public int getEnergyWaterConsumptionCorrectionCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getEnergyWaterConsumptionCorrectionAtIndex

@Nullable
public ConsumptionCorrectionType getEnergyWaterConsumptionCorrectionAtIndex(@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!

addEnergyWaterConsumptionCorrection

public void addEnergyWaterConsumptionCorrection(@Nonnull
                                                ConsumptionCorrectionType 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
                    EnergyWaterSupplyType 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 EnergyWaterSupplyType 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.