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

Class ConsumptionType

java.lang.Object

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

public class ConsumptionType
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. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe the consumption of a utility.</ccts:Definition>
                <ccts:ObjectClass>Consumption</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ConsumptionType complex type.

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

 <complexType name="ConsumptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UtilityStatementTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}MainPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AllowanceCharge" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxTotal" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EnergyWaterSupply" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TelecommunicationsSupply" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LegalMonetaryTotal"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AllowanceChargeType>	allowanceCharge
protected EnergyWaterSupplyType	energyWaterSupply
protected MonetaryTotalType	legalMonetaryTotal
protected PeriodType	mainPeriod
protected List<TaxTotalType>	taxTotal
protected TelecommunicationsSupplyType	telecommunicationsSupply
protected UtilityStatementTypeCodeType	utilityStatementTypeCode

Constructor Summary

Constructors

Constructor and Description
ConsumptionType()

Method Summary

Modifier and Type	Method and Description
List<AllowanceChargeType>	getAllowanceCharge() <?
EnergyWaterSupplyType	getEnergyWaterSupply() <?
MonetaryTotalType	getLegalMonetaryTotal() <?
PeriodType	getMainPeriod() <?
List<TaxTotalType>	getTaxTotal() <?
TelecommunicationsSupplyType	getTelecommunicationsSupply() <?
UtilityStatementTypeCodeType	getUtilityStatementTypeCode() <?
void	setEnergyWaterSupply(EnergyWaterSupplyType value) Sets the value of the energyWaterSupply property.
void	setLegalMonetaryTotal(MonetaryTotalType value) Sets the value of the legalMonetaryTotal property.
void	setMainPeriod(PeriodType value) Sets the value of the mainPeriod property.
void	setTelecommunicationsSupply(TelecommunicationsSupplyType value) Sets the value of the telecommunicationsSupply property.
void	setUtilityStatementTypeCode(UtilityStatementTypeCodeType value) Sets the value of the utilityStatementTypeCode property.

Methods inherited from class java.lang.Object

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

Field Detail

utilityStatementTypeCode

protected UtilityStatementTypeCodeType utilityStatementTypeCode

mainPeriod

protected PeriodType mainPeriod

allowanceCharge

protected List<AllowanceChargeType> allowanceCharge

taxTotal

protected List<TaxTotalType> taxTotal

energyWaterSupply

protected EnergyWaterSupplyType energyWaterSupply

telecommunicationsSupply

protected TelecommunicationsSupplyType telecommunicationsSupply

legalMonetaryTotal

protected MonetaryTotalType legalMonetaryTotal

Constructor Detail

ConsumptionType

public ConsumptionType()

Method Detail

getUtilityStatementTypeCode

public UtilityStatementTypeCodeType getUtilityStatementTypeCode()

 <?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. Utility Statement Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code identifying the type of the Utility Statement required for this consumption. Explains the kind of utility the statement is about, e.g.. "gas", "electricity", "telephone"</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Utility Statement Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>Electricity</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is UtilityStatementTypeCodeType

setUtilityStatementTypeCode

public void setUtilityStatementTypeCode(UtilityStatementTypeCodeType value)

Sets the value of the utilityStatementTypeCode property.

Parameters:

value - allowed object is UtilityStatementTypeCodeType

getMainPeriod

public PeriodType getMainPeriod()

 <?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. Main_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period of consumption.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Main</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PeriodType

setMainPeriod

public void setMainPeriod(PeriodType value)

Sets the value of the mainPeriod property.

Parameters:

value - allowed object is PeriodType

getAllowanceCharge

public List<AllowanceChargeType> getAllowanceCharge()

 <?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. Allowance Charge</ccts:DictionaryEntryName>
                      <ccts:Definition>An allowance or charges that may apply with this consumption.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Allowance Charge</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Allowance Charge</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Allowance Charge</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getAllowanceCharge().add(newItem);
 

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

getTaxTotal

public List<TaxTotalType> getTaxTotal()

 <?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. Tax Total</ccts:DictionaryEntryName>
                      <ccts:Definition>The total of taxes for each tax type covering the consumption.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Total</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Tax Total</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Tax Total</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getTaxTotal().add(newItem);
 

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

getEnergyWaterSupply

public EnergyWaterSupplyType getEnergyWaterSupply()

 <?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. Energy Water Supply</ccts:DictionaryEntryName>
                      <ccts:Definition>The details of any energy or water consumption.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Energy Water Supply</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Energy Water Supply</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Energy Water Supply</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is EnergyWaterSupplyType

setEnergyWaterSupply

public void setEnergyWaterSupply(EnergyWaterSupplyType value)

Sets the value of the energyWaterSupply property.

Parameters:

value - allowed object is EnergyWaterSupplyType

getTelecommunicationsSupply

public TelecommunicationsSupplyType getTelecommunicationsSupply()

 <?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. Telecommunications Supply</ccts:DictionaryEntryName>
                      <ccts:Definition>The details of any telecommunications consumption.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Telecommunications Supply</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Telecommunications Supply</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Telecommunications Supply</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is TelecommunicationsSupplyType

setTelecommunicationsSupply

public void setTelecommunicationsSupply(TelecommunicationsSupplyType value)

Sets the value of the telecommunicationsSupply property.

Parameters:

value - allowed object is TelecommunicationsSupplyType

getLegalMonetaryTotal

public MonetaryTotalType getLegalMonetaryTotal()

 <?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. Legal_ Monetary Total. Monetary Total</ccts:DictionaryEntryName>
                      <ccts:Definition>The total amount payable on this consumption, including any allowances, charges, or taxes.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Legal</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Monetary Total</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Monetary Total</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Monetary Total</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is MonetaryTotalType

setLegalMonetaryTotal

public void setLegalMonetaryTotal(MonetaryTotalType value)

Sets the value of the legalMonetaryTotal property.

Parameters:

value - allowed object is MonetaryTotalType