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

Class SubscriberConsumptionType

java.lang.Object

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

public class SubscriberConsumptionType
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>Subscriber Consumption. Details</ccts:DictionaryEntryName>
                <ccts:Definition>The consumption for a specific party for given consumption point provided by a numbers of suppliers. An enterprise can have one utility statement for several parties (e.g. a ministry of defence receiving a telephone bill). In this way each subscriber consumption represent a sub utility statement.</ccts:Definition>
                <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
             </ccts:Component>
 

Java class for SubscriberConsumptionType complex type.

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

 <complexType name="SubscriberConsumptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SpecificationTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TotalMeteredQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SubscriberParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}UtilityConsumptionPoint"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}OnAccountPayment" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Consumption" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SupplierConsumption" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsumptionType	consumption
protected ConsumptionIDType	consumptionID
protected List<NoteType>	note
protected List<OnAccountPaymentType>	onAccountPayment
protected SpecificationTypeCodeType	specificationTypeCode
protected PartyType	subscriberParty
protected List<SupplierConsumptionType>	supplierConsumption
protected TotalMeteredQuantityType	totalMeteredQuantity
protected ConsumptionPointType	utilityConsumptionPoint

Constructor Summary

Constructors

Constructor and Description
SubscriberConsumptionType()

Method Summary

Modifier and Type	Method and Description
ConsumptionType	getConsumption() <?
ConsumptionIDType	getConsumptionID() <?
List<NoteType>	getNote() <?
List<OnAccountPaymentType>	getOnAccountPayment() <?
SpecificationTypeCodeType	getSpecificationTypeCode() <?
PartyType	getSubscriberParty() <?
List<SupplierConsumptionType>	getSupplierConsumption() <?
TotalMeteredQuantityType	getTotalMeteredQuantity() <?
ConsumptionPointType	getUtilityConsumptionPoint() <?
void	setConsumption(ConsumptionType value) Sets the value of the consumption property.
void	setConsumptionID(ConsumptionIDType value) Sets the value of the consumptionID property.
void	setSpecificationTypeCode(SpecificationTypeCodeType value) Sets the value of the specificationTypeCode property.
void	setSubscriberParty(PartyType value) Sets the value of the subscriberParty property.
void	setTotalMeteredQuantity(TotalMeteredQuantityType value) Sets the value of the totalMeteredQuantity property.
void	setUtilityConsumptionPoint(ConsumptionPointType value) Sets the value of the utilityConsumptionPoint property.

Methods inherited from class java.lang.Object

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

Field Detail

consumptionID

protected ConsumptionIDType consumptionID

specificationTypeCode

protected SpecificationTypeCodeType specificationTypeCode

note

protected List<NoteType> note

totalMeteredQuantity

protected TotalMeteredQuantityType totalMeteredQuantity

subscriberParty

protected PartyType subscriberParty

utilityConsumptionPoint

protected ConsumptionPointType utilityConsumptionPoint

onAccountPayment

protected List<OnAccountPaymentType> onAccountPayment

consumption

protected ConsumptionType consumption

supplierConsumption

protected List<SupplierConsumptionType> supplierConsumption

Constructor Detail

SubscriberConsumptionType

public SubscriberConsumptionType()

Method Detail

getConsumptionID

public ConsumptionIDType getConsumptionID()

 <?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>Subscriber Consumption. Consumption Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>The identifier tor this specification.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ConsumptionIDType

setConsumptionID

public void setConsumptionID(ConsumptionIDType value)

Sets the value of the consumptionID property.

Parameters:

value - allowed object is ConsumptionIDType

getSpecificationTypeCode

public SpecificationTypeCodeType getSpecificationTypeCode()

 <?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>Subscriber Consumption. Specification Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The code which specifies the type of this specification, e.g. an on account specification or the yearly specification.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Specification Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SpecificationTypeCodeType

setSpecificationTypeCode

public void setSpecificationTypeCode(SpecificationTypeCodeType value)

Sets the value of the specificationTypeCode property.

Parameters:

value - allowed object is SpecificationTypeCodeType

getNote

public List<NoteType> getNote()

 <?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>Subscriber Consumption. Note. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Note</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>This is how we have calculating your yearly statement</ccts:Examples>
                   </ccts:Component>
 

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

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

    getNote().add(newItem);
 

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

getTotalMeteredQuantity

public TotalMeteredQuantityType getTotalMeteredQuantity()

 <?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>Subscriber Consumption. Total Metered Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The total quantity consumed, as calculated from meter readings.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Total Metered Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                      <ccts:Examples>2000.0</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is TotalMeteredQuantityType

setTotalMeteredQuantity

public void setTotalMeteredQuantity(TotalMeteredQuantityType value)

Sets the value of the totalMeteredQuantity property.

Parameters:

value - allowed object is TotalMeteredQuantityType

getSubscriberParty

public PartyType getSubscriberParty()

 <?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>Subscriber Consumption. Subscriber_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The party subscribing to the utility.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Subscriber</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PartyType

setSubscriberParty

public void setSubscriberParty(PartyType value)

Sets the value of the subscriberParty property.

Parameters:

value - allowed object is PartyType

getUtilityConsumptionPoint

public ConsumptionPointType getUtilityConsumptionPoint()

 <?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>Subscriber Consumption. Utility_ Consumption Point. Consumption Point</ccts:DictionaryEntryName>
                      <ccts:Definition>The point at which the utility is consumed.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Utility</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Consumption Point</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Consumption Point</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Consumption Point</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is ConsumptionPointType

setUtilityConsumptionPoint

public void setUtilityConsumptionPoint(ConsumptionPointType value)

Sets the value of the utilityConsumptionPoint property.

Parameters:

value - allowed object is ConsumptionPointType

getOnAccountPayment

public List<OnAccountPaymentType> getOnAccountPayment()

 <?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>Subscriber Consumption. On Account Payment</ccts:DictionaryEntryName>
                      <ccts:Definition>The planned prepayments (on account) regarding this subscription.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>On Account Payment</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>On Account Payment</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>On Account Payment</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getOnAccountPayment().add(newItem);
 

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

getConsumption

public ConsumptionType getConsumption()

 <?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>Subscriber Consumption. Consumption</ccts:DictionaryEntryName>
                      <ccts:Definition>The consumption in case the consumption is from one and only one supplier.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Consumption</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Consumption</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is ConsumptionType

setConsumption

public void setConsumption(ConsumptionType value)

Sets the value of the consumption property.

Parameters:

value - allowed object is ConsumptionType

getSupplierConsumption

public List<SupplierConsumptionType> getSupplierConsumption()

 <?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>Subscriber Consumption. Supplier Consumption</ccts:DictionaryEntryName>
                      <ccts:Definition>The consumption in case the consumption is from more than one supplier.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Subscriber Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Supplier Consumption</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Supplier Consumption</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Supplier Consumption</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getSupplierConsumption().add(newItem);
 

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