ConsumptionReportType (Difi Commons :: Universal Business Language (UBL) 2.1 0.9.5 API)

java.lang.Object
- no.difi.commons.ubl21.jaxb.cac.ConsumptionReportType

public class ConsumptionReportType
extends Object

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

Constructors
Constructor and Description
`ConsumptionReportType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasicConsumedQuantityType`	`getBasicConsumedQuantity()` Gets the value of the basicConsumedQuantity property.
`ConsumersEnergyLevelType`	`getConsumersEnergyLevel()` Gets the value of the consumersEnergyLevel property.
`ConsumersEnergyLevelCodeType`	`getConsumersEnergyLevelCode()` Gets the value of the consumersEnergyLevelCode property.
`List<ConsumptionHistoryType>`	`getConsumptionHistory()` Gets the value of the consumptionHistory property.
`List<ConsumptionReportReferenceType>`	`getConsumptionReportReference()` Gets the value of the consumptionReportReference property.
`ConsumptionTypeType`	`getConsumptionType()` Gets the value of the consumptionType property.
`ConsumptionTypeCodeType`	`getConsumptionTypeCode()` Gets the value of the consumptionTypeCode property.
`List<DescriptionType>`	`getDescription()` Gets the value of the description property.
`DocumentReferenceType`	`getDocumentReference()` Gets the value of the documentReference property.
`DocumentReferenceType`	`getGuidanceDocumentReference()` Gets the value of the guidanceDocumentReference property.
`HeatingTypeType`	`getHeatingType()` Gets the value of the heatingType property.
`HeatingTypeCodeType`	`getHeatingTypeCode()` Gets the value of the heatingTypeCode property.
`IDType`	`getID()` Gets the value of the id property.
`PeriodType`	`getPeriod()` Gets the value of the period property.
`ResidenceTypeType`	`getResidenceType()` Gets the value of the residenceType property.
`ResidenceTypeCodeType`	`getResidenceTypeCode()` Gets the value of the residenceTypeCode property.
`ResidentOccupantsNumericType`	`getResidentOccupantsNumeric()` Gets the value of the residentOccupantsNumeric property.
`TotalConsumedQuantityType`	`getTotalConsumedQuantity()` Gets the value of the totalConsumedQuantity property.
`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()
```
    Gets the value of the id property.
    
    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()
```
    Gets the value of the consumptionType property.
    
    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()
```
    Gets the value of the consumptionTypeCode property.
    
    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()
```
    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()
```
    Gets the value of the totalConsumedQuantity property.
    
    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()
```
    Gets the value of the basicConsumedQuantity property.
    
    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()
```
    Gets the value of the residentOccupantsNumeric property.
    
    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()
```
    Gets the value of the consumersEnergyLevelCode property.
    
    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()
```
    Gets the value of the consumersEnergyLevel property.
    
    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()
```
    Gets the value of the residenceType property.
    
    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()
```
    Gets the value of the residenceTypeCode property.
    
    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()
```
    Gets the value of the heatingType property.
    
    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()
```
    Gets the value of the heatingTypeCode property.
    
    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()
```
    Gets the value of the period property.
    
    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()
```
    Gets the value of the guidanceDocumentReference property.
    
    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()
```
    Gets the value of the documentReference property.
    
    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()
```
    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()
```
    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

Class ConsumptionReportType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

consumptionType

consumptionTypeCode

description

totalConsumedQuantity

basicConsumedQuantity

residentOccupantsNumeric

consumersEnergyLevelCode

consumersEnergyLevel

residenceType

residenceTypeCode

heatingType

heatingTypeCode

period

guidanceDocumentReference

documentReference

consumptionReportReference

consumptionHistory

Constructor Detail

ConsumptionReportType

Method Detail

getID

setID

getConsumptionType

setConsumptionType

getConsumptionTypeCode

setConsumptionTypeCode

getDescription

getTotalConsumedQuantity

setTotalConsumedQuantity

getBasicConsumedQuantity

setBasicConsumedQuantity

getResidentOccupantsNumeric

setResidentOccupantsNumeric

getConsumersEnergyLevelCode

setConsumersEnergyLevelCode

getConsumersEnergyLevel

setConsumersEnergyLevel

getResidenceType

setResidenceType

getResidenceTypeCode

setResidenceTypeCode

getHeatingType

setHeatingType

getHeatingTypeCode

setHeatingTypeCode

getPeriod

setPeriod

getGuidanceDocumentReference

setGuidanceDocumentReference

getDocumentReference

setDocumentReference

getConsumptionReportReference

getConsumptionHistory