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

Class ConsumptionPointType

java.lang.Object

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

public class ConsumptionPointType
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 Point. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define the point of consumption for a utility, such as a meter.</ccts:Definition>
                <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ConsumptionPointType complex type.

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

 <complexType name="ConsumptionPointType">
   <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}Description" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SubscriberID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SubscriberType" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SubscriberTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TotalDeliveredQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Address" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}WebSiteAccess" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}UtilityMeter" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressType	address
protected List<DescriptionType>	description
protected IDType	id
protected SubscriberIDType	subscriberID
protected SubscriberTypeType	subscriberType
protected SubscriberTypeCodeType	subscriberTypeCode
protected TotalDeliveredQuantityType	totalDeliveredQuantity
protected List<MeterType>	utilityMeter
protected WebSiteAccessType	webSiteAccess

Constructor Summary

Constructors

Constructor and Description
ConsumptionPointType()

Method Summary

Modifier and Type	Method and Description
AddressType	getAddress() <?
List<DescriptionType>	getDescription() <?
IDType	getID() <?
SubscriberIDType	getSubscriberID() <?
SubscriberTypeType	getSubscriberType() <?
SubscriberTypeCodeType	getSubscriberTypeCode() <?
TotalDeliveredQuantityType	getTotalDeliveredQuantity() <?
List<MeterType>	getUtilityMeter() <?
WebSiteAccessType	getWebSiteAccess() <?
void	setAddress(AddressType value) Sets the value of the address property.
void	setID(IDType value) Sets the value of the id property.
void	setSubscriberID(SubscriberIDType value) Sets the value of the subscriberID property.
void	setSubscriberType(SubscriberTypeType value) Sets the value of the subscriberType property.
void	setSubscriberTypeCode(SubscriberTypeCodeType value) Sets the value of the subscriberTypeCode property.
void	setTotalDeliveredQuantity(TotalDeliveredQuantityType value) Sets the value of the totalDeliveredQuantity property.
void	setWebSiteAccess(WebSiteAccessType value) Sets the value of the webSiteAccess 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

description

protected List<DescriptionType> description

subscriberID

protected SubscriberIDType subscriberID

subscriberType

protected SubscriberTypeType subscriberType

subscriberTypeCode

protected SubscriberTypeCodeType subscriberTypeCode

totalDeliveredQuantity

protected TotalDeliveredQuantityType totalDeliveredQuantity

address

protected AddressType address

webSiteAccess

protected WebSiteAccessType webSiteAccess

utilityMeter

protected List<MeterType> utilityMeter

Constructor Detail

ConsumptionPointType

public ConsumptionPointType()

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 Point. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this point of consumption.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTerm>Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>7411013716x</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

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 Point. Description. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Text describing this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTerm>Description</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>Additional informations concerning the consumption point</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

getSubscriberID

public SubscriberIDType getSubscriberID()

 <?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 Point. Subscriber Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for the subscriber responsible for the consumption at this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTerm>Subscriber Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>98143211</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is SubscriberIDType

setSubscriberID

public void setSubscriberID(SubscriberIDType value)

Sets the value of the subscriberID property.

Parameters:

value - allowed object is SubscriberIDType

getSubscriberType

public SubscriberTypeType getSubscriberType()

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

Returns:

possible object is SubscriberTypeType

setSubscriberType

public void setSubscriberType(SubscriberTypeType value)

Sets the value of the subscriberType property.

Parameters:

value - allowed object is SubscriberTypeType

getSubscriberTypeCode

public SubscriberTypeCodeType getSubscriberTypeCode()

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

Returns:

possible object is SubscriberTypeCodeType

setSubscriberTypeCode

public void setSubscriberTypeCode(SubscriberTypeCodeType value)

Sets the value of the subscriberTypeCode property.

Parameters:

value - allowed object is SubscriberTypeCodeType

getTotalDeliveredQuantity

public TotalDeliveredQuantityType getTotalDeliveredQuantity()

 <?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 Point. Total_ Delivered Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The total quantity delivered, calculated at this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Total</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Delivered Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                      <ccts:Examples>5761.00</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is TotalDeliveredQuantityType

setTotalDeliveredQuantity

public void setTotalDeliveredQuantity(TotalDeliveredQuantityType value)

Sets the value of the totalDeliveredQuantity property.

Parameters:

value - allowed object is TotalDeliveredQuantityType

getAddress

public AddressType getAddress()

 <?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 Point. Address</ccts:DictionaryEntryName>
                      <ccts:Definition>The address of this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTerm>Address</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Address</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Address</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is AddressType

setAddress

public void setAddress(AddressType value)

Sets the value of the address property.

Parameters:

value - allowed object is AddressType

getWebSiteAccess

public WebSiteAccessType getWebSiteAccess()

 <?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 Point. Web Site Access</ccts:DictionaryEntryName>
                      <ccts:Definition>Access information for the website of this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTerm>Web Site Access</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Web Site Access</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Web Site Access</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is WebSiteAccessType

setWebSiteAccess

public void setWebSiteAccess(WebSiteAccessType value)

Sets the value of the webSiteAccess property.

Parameters:

value - allowed object is WebSiteAccessType

getUtilityMeter

public List<MeterType> getUtilityMeter()

 <?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 Point. Utility_ Meter. Meter</ccts:DictionaryEntryName>
                      <ccts:Definition>A meter at this consumption point.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Point</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Utility</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Meter</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Meter</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Meter</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getUtilityMeter().add(newItem);
 

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