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

Class ConsumptionHistoryType

java.lang.Object

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

public class ConsumptionHistoryType
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>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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AmountType	amount
protected ConsumptionLevelType	consumptionLevel
protected ConsumptionLevelCodeType	consumptionLevelCode
protected List<DescriptionType>	description
protected MeterNumberType	meterNumber
protected PeriodType	period
protected QuantityType	quantity

Constructor Summary

Constructors

Constructor and Description
ConsumptionHistoryType()

Method Summary

Modifier and Type	Method and Description
AmountType	getAmount() <?
ConsumptionLevelType	getConsumptionLevel() <?
ConsumptionLevelCodeType	getConsumptionLevelCode() <?
List<DescriptionType>	getDescription() <?
MeterNumberType	getMeterNumber() <?
PeriodType	getPeriod() <?
QuantityType	getQuantity() <?
void	setAmount(AmountType value) Sets the value of the amount property.
void	setConsumptionLevel(ConsumptionLevelType value) Sets the value of the consumptionLevel property.
void	setConsumptionLevelCode(ConsumptionLevelCodeType value) Sets the value of the consumptionLevelCode property.
void	setMeterNumber(MeterNumberType value) Sets the value of the meterNumber property.
void	setPeriod(PeriodType value) Sets the value of the period property.
void	setQuantity(QuantityType value) Sets the value of the quantity property.

Methods inherited from class java.lang.Object

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

Field Detail

meterNumber

protected MeterNumberType meterNumber

quantity

protected QuantityType quantity

amount

protected AmountType amount

consumptionLevelCode

protected ConsumptionLevelCodeType consumptionLevelCode

consumptionLevel

protected ConsumptionLevelType consumptionLevel

description

protected List<DescriptionType> description

period

protected PeriodType period

Constructor Detail

ConsumptionHistoryType

public ConsumptionHistoryType()

Method Detail

getMeterNumber

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(MeterNumberType value)

Sets the value of the meterNumber property.

Parameters:

value - allowed object is MeterNumberType

getQuantity

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(QuantityType value)

Sets the value of the quantity property.

Parameters:

value - allowed object is QuantityType

getAmount

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(AmountType value)

Sets the value of the amount property.

Parameters:

value - allowed object is AmountType

getConsumptionLevelCode

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(ConsumptionLevelCodeType value)

Sets the value of the consumptionLevelCode property.

Parameters:

value - allowed object is ConsumptionLevelCodeType

getConsumptionLevel

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(ConsumptionLevelType value)

Sets the value of the consumptionLevel property.

Parameters:

value - allowed object is ConsumptionLevelType

getDescription

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

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(PeriodType value)

Sets the value of the period property.

Parameters:

value - allowed object is PeriodType