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

Class ConsumptionHistoryType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ConsumptionHistoryType
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 History. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe the measurement of a type of consumption during a particular period, used for the subscriber to get an overview of his consumption</ccts:Definition><ccts:ObjectClass>Consumption History</ccts:ObjectClass></ccts:Component>
 

Java class for ConsumptionHistoryType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addDescription(DescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ConsumptionHistoryType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ConsumptionHistoryType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
AmountType	getAmount() <?
BigDecimal	getAmountValue() Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ConsumptionLevelType	getConsumptionLevel() <?
ConsumptionLevelCodeType	getConsumptionLevelCode() <?
String	getConsumptionLevelCodeValue() Get the value of the contained ConsumptionLevelCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
String	getConsumptionLevelValue() Get the value of the contained ConsumptionLevelType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<DescriptionType>	getDescription() <?
DescriptionType	getDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
MeterNumberType	getMeterNumber() <?
String	getMeterNumberValue() Get the value of the contained MeterNumberType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PeriodType	getPeriod() <?
QuantityType	getQuantity() <?
BigDecimal	getQuantityValue() Get the value of the contained QuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setAmount(AmountType value) Sets the value of the amount property.
AmountType	setAmount(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setConsumptionLevel(ConsumptionLevelType value) Sets the value of the consumptionLevel property.
ConsumptionLevelType	setConsumptionLevel(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setConsumptionLevelCode(ConsumptionLevelCodeType value) Sets the value of the consumptionLevelCode property.
ConsumptionLevelCodeType	setConsumptionLevelCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDescription(List<DescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setMeterNumber(MeterNumberType value) Sets the value of the meterNumber property.
MeterNumberType	setMeterNumber(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setPeriod(PeriodType value) Sets the value of the period property.
QuantityType	setQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setQuantity(QuantityType value) Sets the value of the quantity 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

ConsumptionHistoryType

public ConsumptionHistoryType()

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

Method Detail

getMeterNumber

@Nullable
public MeterNumberType getMeterNumber()

 <?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 History. Meter Number. Text</ccts:DictionaryEntryName><ccts:Definition>A text identifier for the meter measuring the consumption.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Meter Number</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>61722x</ccts:Examples></ccts:Component>
 

Returns:

possible object is MeterNumberType

setMeterNumber

public void setMeterNumber(@Nullable
                           MeterNumberType value)

Sets the value of the meterNumber property.

Parameters:

value - allowed object is MeterNumberType

getQuantity

@Nullable
public QuantityType getQuantity()

 <?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 History. Quantity</ccts:DictionaryEntryName><ccts:Definition>The quantity consumed.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Quantity</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType><ccts:Examples>7621.00</ccts:Examples></ccts:Component>
 

Returns:

possible object is QuantityType

setQuantity

public void setQuantity(@Nullable
                        QuantityType value)

Sets the value of the quantity property.

Parameters:

value - allowed object is QuantityType

getAmount

@Nullable
public AmountType getAmount()

 <?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 History. Amount</ccts:DictionaryEntryName><ccts:Definition>The monetary amount to be charged for the quantity consumed.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is AmountType

setAmount

public void setAmount(@Nullable
                      AmountType value)

Sets the value of the amount property.

Parameters:

value - allowed object is AmountType

getConsumptionLevelCode

@Nullable
public ConsumptionLevelCodeType getConsumptionLevelCode()

 <?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 History. Consumption Level Code. Code</ccts:DictionaryEntryName><ccts:Definition>The consumption level, expressed as a code used explain the consumption quantity, e.g.. diversion from the normal.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Consumption Level Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>B</ccts:Examples></ccts:Component>
 

Returns:

possible object is ConsumptionLevelCodeType

setConsumptionLevelCode

public void setConsumptionLevelCode(@Nullable
                                    ConsumptionLevelCodeType value)

Sets the value of the consumptionLevelCode property.

Parameters:

value - allowed object is ConsumptionLevelCodeType

getConsumptionLevel

@Nullable
public ConsumptionLevelType getConsumptionLevel()

 <?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 History. Consumption Level Text. Text</ccts:DictionaryEntryName><ccts:Definition>The consumption level, expressed as text, used explain the consumption quantity, e.g.. diversion from the normal.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Consumption Level Text</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>Average</ccts:Examples></ccts:Component>
 

Returns:

possible object is ConsumptionLevelType

setConsumptionLevel

public void setConsumptionLevel(@Nullable
                                ConsumptionLevelType value)

Sets the value of the consumptionLevel property.

Parameters:

value - allowed object is ConsumptionLevelType

getDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionType> getDescription()

 <?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 History. Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the consumption itself.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>2004/2005</ccts:Examples></ccts:Component>
 

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

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

    getDescription().add(newItem);
 

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

getPeriod

@Nullable
public PeriodType getPeriod()

 <?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 History. Period</ccts:DictionaryEntryName><ccts:Definition>The period during which the consumption took place.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption History</ccts:ObjectClass><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setPeriod

public void setPeriod(@Nullable
                      PeriodType value)

Sets the value of the period property.

Parameters:

value - allowed object is PeriodType

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

setDescription

public void setDescription(@Nullable
                           List<DescriptionType> aList)

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

Parameters:

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

hasDescriptionEntries

public boolean hasDescriptionEntries()

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

Returns:

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

hasNoDescriptionEntries

public boolean hasNoDescriptionEntries()

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

Returns:

true if no item is contained, false otherwise.

getDescriptionCount

@Nonnegative
public int getDescriptionCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getDescriptionAtIndex

@Nullable
public DescriptionType getDescriptionAtIndex(@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!

addDescription

public void addDescription(@Nonnull
                           DescriptionType 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
                    ConsumptionHistoryType 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 ConsumptionHistoryType 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.

setAmount

@Nonnull
public AmountType setAmount(@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 null.

Returns:

The created intermediary object of type AmountType and never null

setConsumptionLevelCode

@Nonnull
public ConsumptionLevelCodeType setConsumptionLevelCode(@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 ConsumptionLevelCodeType and never null

setQuantity

@Nonnull
public QuantityType setQuantity(@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 null.

Returns:

The created intermediary object of type QuantityType and never null

setMeterNumber

@Nonnull
public MeterNumberType setMeterNumber(@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 MeterNumberType and never null

setConsumptionLevel

@Nonnull
public ConsumptionLevelType setConsumptionLevel(@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 ConsumptionLevelType and never null

getMeterNumberValue

@Nullable
public String getMeterNumberValue()

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

Returns:

Either the value of the contained MeterNumberType object or null

getQuantityValue

@Nullable
public BigDecimal getQuantityValue()

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

Returns:

Either the value of the contained QuantityType object or null

getAmountValue

@Nullable
public BigDecimal getAmountValue()

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

Returns:

Either the value of the contained AmountType object or null

getConsumptionLevelCodeValue

@Nullable
public String getConsumptionLevelCodeValue()

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

Returns:

Either the value of the contained ConsumptionLevelCodeType object or null

getConsumptionLevelValue

@Nullable
public String getConsumptionLevelValue()

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

Returns:

Either the value of the contained ConsumptionLevelType object or null