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

Class ConsumptionReportType

java.lang.Object

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

public class ConsumptionReportType
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 Report. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe utility consumption, including details of the environment in which consumption takes place.</ccts:Definition>
                <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ConsumptionReportType complex type.

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

 <complexType name="ConsumptionReportType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionTypeCode" 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:CommonBasicComponents-2}TotalConsumedQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}BasicConsumedQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ResidentOccupantsNumeric" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumersEnergyLevelCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumersEnergyLevel" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ResidenceType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ResidenceTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}HeatingType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}HeatingTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Period" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}GuidanceDocumentReference" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DocumentReference" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsumptionReportReference" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsumptionHistory" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicConsumedQuantityType	basicConsumedQuantity
protected ConsumersEnergyLevelType	consumersEnergyLevel
protected ConsumersEnergyLevelCodeType	consumersEnergyLevelCode
protected List<ConsumptionHistoryType>	consumptionHistory
protected List<ConsumptionReportReferenceType>	consumptionReportReference
protected ConsumptionTypeType	consumptionType
protected ConsumptionTypeCodeType	consumptionTypeCode
protected List<DescriptionType>	description
protected DocumentReferenceType	documentReference
protected DocumentReferenceType	guidanceDocumentReference
protected HeatingTypeType	heatingType
protected HeatingTypeCodeType	heatingTypeCode
protected IDType	id
protected PeriodType	period
protected ResidenceTypeType	residenceType
protected ResidenceTypeCodeType	residenceTypeCode
protected ResidentOccupantsNumericType	residentOccupantsNumeric
protected TotalConsumedQuantityType	totalConsumedQuantity

Constructor Summary

Constructors

Constructor and Description
ConsumptionReportType()

Method Summary

Modifier and Type	Method and Description
BasicConsumedQuantityType	getBasicConsumedQuantity() <?
ConsumersEnergyLevelType	getConsumersEnergyLevel() <?
ConsumersEnergyLevelCodeType	getConsumersEnergyLevelCode() <?
List<ConsumptionHistoryType>	getConsumptionHistory() <?
List<ConsumptionReportReferenceType>	getConsumptionReportReference() <?
ConsumptionTypeType	getConsumptionType() <?
ConsumptionTypeCodeType	getConsumptionTypeCode() <?
List<DescriptionType>	getDescription() <?
DocumentReferenceType	getDocumentReference() <?
DocumentReferenceType	getGuidanceDocumentReference() <?
HeatingTypeType	getHeatingType() <?
HeatingTypeCodeType	getHeatingTypeCode() <?
IDType	getID() <?
PeriodType	getPeriod() <?
ResidenceTypeType	getResidenceType() <?
ResidenceTypeCodeType	getResidenceTypeCode() <?
ResidentOccupantsNumericType	getResidentOccupantsNumeric() <?
TotalConsumedQuantityType	getTotalConsumedQuantity() <?
void	setBasicConsumedQuantity(BasicConsumedQuantityType value) Sets the value of the basicConsumedQuantity property.
void	setConsumersEnergyLevel(ConsumersEnergyLevelType value) Sets the value of the consumersEnergyLevel property.
void	setConsumersEnergyLevelCode(ConsumersEnergyLevelCodeType value) Sets the value of the consumersEnergyLevelCode property.
void	setConsumptionType(ConsumptionTypeType value) Sets the value of the consumptionType property.
void	setConsumptionTypeCode(ConsumptionTypeCodeType value) Sets the value of the consumptionTypeCode property.
void	setDocumentReference(DocumentReferenceType value) Sets the value of the documentReference property.
void	setGuidanceDocumentReference(DocumentReferenceType value) Sets the value of the guidanceDocumentReference property.
void	setHeatingType(HeatingTypeType value) Sets the value of the heatingType property.
void	setHeatingTypeCode(HeatingTypeCodeType value) Sets the value of the heatingTypeCode property.
void	setID(IDType value) Sets the value of the id property.
void	setPeriod(PeriodType value) Sets the value of the period property.
void	setResidenceType(ResidenceTypeType value) Sets the value of the residenceType property.
void	setResidenceTypeCode(ResidenceTypeCodeType value) Sets the value of the residenceTypeCode property.
void	setResidentOccupantsNumeric(ResidentOccupantsNumericType value) Sets the value of the residentOccupantsNumeric property.
void	setTotalConsumedQuantity(TotalConsumedQuantityType value) Sets the value of the totalConsumedQuantity property.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected IDType id

consumptionType

protected ConsumptionTypeType consumptionType

consumptionTypeCode

protected ConsumptionTypeCodeType consumptionTypeCode

description

protected List<DescriptionType> description

totalConsumedQuantity

protected TotalConsumedQuantityType totalConsumedQuantity

basicConsumedQuantity

protected BasicConsumedQuantityType basicConsumedQuantity

residentOccupantsNumeric

protected ResidentOccupantsNumericType residentOccupantsNumeric

consumersEnergyLevelCode

protected ConsumersEnergyLevelCodeType consumersEnergyLevelCode

consumersEnergyLevel

protected ConsumersEnergyLevelType consumersEnergyLevel

residenceType

protected ResidenceTypeType residenceType

residenceTypeCode

protected ResidenceTypeCodeType residenceTypeCode

heatingType

protected HeatingTypeType heatingType

heatingTypeCode

protected HeatingTypeCodeType heatingTypeCode

period

protected PeriodType period

guidanceDocumentReference

protected DocumentReferenceType guidanceDocumentReference

documentReference

protected DocumentReferenceType documentReference

consumptionReportReference

protected List<ConsumptionReportReferenceType> consumptionReportReference

consumptionHistory

protected List<ConsumptionHistoryType> consumptionHistory

Constructor Detail

ConsumptionReportType

public ConsumptionReportType()

Method Detail

getID

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>Consumption Report. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this consumption report.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>n/a</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getConsumptionType

public ConsumptionTypeType getConsumptionType()

 <?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 Report. Consumption Type. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of consumption, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption Type</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>Consumption</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ConsumptionTypeType

setConsumptionType

public void setConsumptionType(ConsumptionTypeType value)

Sets the value of the consumptionType property.

Parameters:

value - allowed object is ConsumptionTypeType

getConsumptionTypeCode

public ConsumptionTypeCodeType getConsumptionTypeCode()

 <?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 Report. Consumption Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of consumption, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>Consumption</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ConsumptionTypeCodeType

setConsumptionTypeCode

public void setConsumptionTypeCode(ConsumptionTypeCodeType value)

Sets the value of the consumptionTypeCode property.

Parameters:

value - allowed object is ConsumptionTypeCodeType

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 Report. Description. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Text reporting utility consumption.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Description</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>This report contain the latest year consumption</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

getTotalConsumedQuantity

public TotalConsumedQuantityType getTotalConsumedQuantity()

 <?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 Report. Total_ Consumed Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The total quantity consumed.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Total</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Consumed Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                      <ccts:Examples>20479.00</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is TotalConsumedQuantityType

setTotalConsumedQuantity

public void setTotalConsumedQuantity(TotalConsumedQuantityType value)

Sets the value of the totalConsumedQuantity property.

Parameters:

value - allowed object is TotalConsumedQuantityType

getBasicConsumedQuantity

public BasicConsumedQuantityType getBasicConsumedQuantity()

 <?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 Report. Basic_ Consumed Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The basic quantity consumed, excluding additional consumption.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Basic</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Consumed Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                      <ccts:Examples>20000.00</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is BasicConsumedQuantityType

setBasicConsumedQuantity

public void setBasicConsumedQuantity(BasicConsumedQuantityType value)

Sets the value of the basicConsumedQuantity property.

Parameters:

value - allowed object is BasicConsumedQuantityType

getResidentOccupantsNumeric

public ResidentOccupantsNumericType getResidentOccupantsNumeric()

 <?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 Report. Resident_ Occupants Numeric. Numeric</ccts:DictionaryEntryName>
                      <ccts:Definition>The number of people occupying the residence covered by this report.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Resident</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Occupants Numeric</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm>
                      <ccts:DataType>Numeric. Type</ccts:DataType>
                      <ccts:Examples>4.0</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ResidentOccupantsNumericType

setResidentOccupantsNumeric

public void setResidentOccupantsNumeric(ResidentOccupantsNumericType value)

Sets the value of the residentOccupantsNumeric property.

Parameters:

value - allowed object is ResidentOccupantsNumericType

getConsumersEnergyLevelCode

public ConsumersEnergyLevelCodeType getConsumersEnergyLevelCode()

 <?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 Report. Consumers_ Energy Level Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The level of energy consumed, compared to the average for this residence type and the number of people living in the residence, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Consumers</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Energy 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 ConsumersEnergyLevelCodeType

setConsumersEnergyLevelCode

public void setConsumersEnergyLevelCode(ConsumersEnergyLevelCodeType value)

Sets the value of the consumersEnergyLevelCode property.

Parameters:

value - allowed object is ConsumersEnergyLevelCodeType

getConsumersEnergyLevel

public ConsumersEnergyLevelType getConsumersEnergyLevel()

 <?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 Report. Consumers_ Energy Level. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The level of energy consumed, compared to the average for this residence type and the number of people living in the residence, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Consumers</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Energy Level</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>Middel</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ConsumersEnergyLevelType

setConsumersEnergyLevel

public void setConsumersEnergyLevel(ConsumersEnergyLevelType value)

Sets the value of the consumersEnergyLevel property.

Parameters:

value - allowed object is ConsumersEnergyLevelType

getResidenceType

public ResidenceTypeType getResidenceType()

 <?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 Report. Residence Type. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of residence (house, apartment, etc.) covered in this report, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Residence Type</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>House</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ResidenceTypeType

setResidenceType

public void setResidenceType(ResidenceTypeType value)

Sets the value of the residenceType property.

Parameters:

value - allowed object is ResidenceTypeType

getResidenceTypeCode

public ResidenceTypeCodeType getResidenceTypeCode()

 <?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 Report. Residence Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of residence (house, apartment, etc.) covered in this report, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Residence Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>House</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ResidenceTypeCodeType

setResidenceTypeCode

public void setResidenceTypeCode(ResidenceTypeCodeType value)

Sets the value of the residenceTypeCode property.

Parameters:

value - allowed object is ResidenceTypeCodeType

getHeatingType

public HeatingTypeType getHeatingType()

 <?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 Report. Heating Type. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of heating in the residence covered in this report, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Heating Type</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>District heating</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is HeatingTypeType

setHeatingType

public void setHeatingType(HeatingTypeType value)

Sets the value of the heatingType property.

Parameters:

value - allowed object is HeatingTypeType

getHeatingTypeCode

public HeatingTypeCodeType getHeatingTypeCode()

 <?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 Report. Heating Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of heating in the residence covered in this report, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Heating Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>DistrictHeating</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is HeatingTypeCodeType

setHeatingTypeCode

public void setHeatingTypeCode(HeatingTypeCodeType value)

Sets the value of the heatingTypeCode property.

Parameters:

value - allowed object is HeatingTypeCodeType

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 Report. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period of consumption covered in this report.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</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

getGuidanceDocumentReference

public DocumentReferenceType getGuidanceDocumentReference()

 <?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 Report. Guidance_ Document Reference. Document Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to a document providing an explanation of this kind of report.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Guidance</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Document Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is DocumentReferenceType

setGuidanceDocumentReference

public void setGuidanceDocumentReference(DocumentReferenceType value)

Sets the value of the guidanceDocumentReference property.

Parameters:

value - allowed object is DocumentReferenceType

getDocumentReference

public DocumentReferenceType getDocumentReference()

 <?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 Report. Document Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to some other document (for example, this report in another format).</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Document Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is DocumentReferenceType

setDocumentReference

public void setDocumentReference(DocumentReferenceType value)

Sets the value of the documentReference property.

Parameters:

value - allowed object is DocumentReferenceType

getConsumptionReportReference

public List<ConsumptionReportReferenceType> getConsumptionReportReference()

 <?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 Report. Consumption Report Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to a previous consumption report.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption Report Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Consumption Report Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Consumption Report Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getConsumptionReportReference().add(newItem);
 

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

getConsumptionHistory

public List<ConsumptionHistoryType> getConsumptionHistory()

 <?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 Report. Consumption History</ccts:DictionaryEntryName>
                      <ccts:Definition>A report describing historical parameters relating to a specific instance of consumption.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption History</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Consumption History</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Consumption History</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getConsumptionHistory().add(newItem);
 

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