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

Class ConsumptionReportReferenceType

java.lang.Object

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

public class ConsumptionReportReferenceType
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 Reference. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define a reference to an earlier consumption report (e.g., last year's consumption).</ccts:Definition>
                <ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ConsumptionReportReferenceType complex type.

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

 <complexType name="ConsumptionReportReferenceType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionReportID"/>
         <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}TotalConsumedQuantity"/>
         <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 ConsumptionReportIDType	consumptionReportID
protected ConsumptionTypeType	consumptionType
protected ConsumptionTypeCodeType	consumptionTypeCode
protected PeriodType	period
protected TotalConsumedQuantityType	totalConsumedQuantity

Constructor Summary

Constructors

Constructor and Description
ConsumptionReportReferenceType()

Method Summary

Modifier and Type	Method and Description
ConsumptionReportIDType	getConsumptionReportID() <?
ConsumptionTypeType	getConsumptionType() <?
ConsumptionTypeCodeType	getConsumptionTypeCode() <?
PeriodType	getPeriod() <?
TotalConsumedQuantityType	getTotalConsumedQuantity() <?
void	setConsumptionReportID(ConsumptionReportIDType value) Sets the value of the consumptionReportID property.
void	setConsumptionType(ConsumptionTypeType value) Sets the value of the consumptionType property.
void	setConsumptionTypeCode(ConsumptionTypeCodeType value) Sets the value of the consumptionTypeCode property.
void	setPeriod(PeriodType value) Sets the value of the period 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

consumptionReportID

protected ConsumptionReportIDType consumptionReportID

consumptionType

protected ConsumptionTypeType consumptionType

consumptionTypeCode

protected ConsumptionTypeCodeType consumptionTypeCode

totalConsumedQuantity

protected TotalConsumedQuantityType totalConsumedQuantity

period

protected PeriodType period

Constructor Detail

ConsumptionReportReferenceType

public ConsumptionReportReferenceType()

Method Detail

getConsumptionReportID

public ConsumptionReportIDType getConsumptionReportID()

 <?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 Reference. Consumption_ Report Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for the referenced consumption report.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Consumption</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Report 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 ConsumptionReportIDType

setConsumptionReportID

public void setConsumptionReportID(ConsumptionReportIDType value)

Sets the value of the consumptionReportID property.

Parameters:

value - allowed object is ConsumptionReportIDType

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 Reference. Consumption Type. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The reported consumption type, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report Reference</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 Reference. Consumption Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The reported consumption type, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report Reference</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

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 Reference. Total_ Consumed Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The total quantity consumed during the period of the referenced report.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report Reference</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

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 Reference. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period of consumption covered by the referenced report.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Report Reference</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