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

Class SupplierConsumptionType

java.lang.Object

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

public class SupplierConsumptionType
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>Supplier Consumption. Details</ccts:DictionaryEntryName>
                <ccts:Definition>The consumption in case the consumption is for one and only one supplier.</ccts:Definition>
                <ccts:ObjectClass>Supplier Consumption</ccts:ObjectClass>
             </ccts:Component>
 

Java class for SupplierConsumptionType complex type.

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

 <complexType name="SupplierConsumptionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <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:CommonAggregateComponents-2}UtilitySupplierParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}UtilityCustomerParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Consumption"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Contract" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsumptionLine" maxOccurs="unbounded"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsumptionType	consumption
protected List<ConsumptionLineType>	consumptionLine
protected ContractType	contract
protected List<DescriptionType>	description
protected PartyType	utilityCustomerParty
protected PartyType	utilitySupplierParty

Constructor Summary

Constructors

Constructor and Description
SupplierConsumptionType()

Method Summary

Modifier and Type	Method and Description
ConsumptionType	getConsumption() <?
List<ConsumptionLineType>	getConsumptionLine() <?
ContractType	getContract() <?
List<DescriptionType>	getDescription() <?
PartyType	getUtilityCustomerParty() <?
PartyType	getUtilitySupplierParty() <?
void	setConsumption(ConsumptionType value) Sets the value of the consumption property.
void	setContract(ContractType value) Sets the value of the contract property.
void	setUtilityCustomerParty(PartyType value) Sets the value of the utilityCustomerParty property.
void	setUtilitySupplierParty(PartyType value) Sets the value of the utilitySupplierParty property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected List<DescriptionType> description

utilitySupplierParty

protected PartyType utilitySupplierParty

utilityCustomerParty

protected PartyType utilityCustomerParty

consumption

protected ConsumptionType consumption

contract

protected ContractType contract

consumptionLine

protected List<ConsumptionLineType> consumptionLine

Constructor Detail

SupplierConsumptionType

public SupplierConsumptionType()

Method Detail

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>Supplier Consumption. Description. 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>Supplier Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Description</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>This is what you pay for electricity to DONG Energy North Utility</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

getUtilitySupplierParty

public PartyType getUtilitySupplierParty()

 <?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>Supplier Consumption. Utility Supplier_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The party supplying the utility.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Supplier Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Utility Supplier</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PartyType

setUtilitySupplierParty

public void setUtilitySupplierParty(PartyType value)

Sets the value of the utilitySupplierParty property.

Parameters:

value - allowed object is PartyType

getUtilityCustomerParty

public PartyType getUtilityCustomerParty()

 <?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>Supplier Consumption. Utility Customer_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The utility customer.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Supplier Consumption</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Utility Customer</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PartyType

setUtilityCustomerParty

public void setUtilityCustomerParty(PartyType value)

Sets the value of the utilityCustomerParty property.

Parameters:

value - allowed object is PartyType

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>Supplier Consumption. Consumption</ccts:DictionaryEntryName>
                      <ccts:Definition>The consumption regarding this supplier</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Supplier 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

getContract

public ContractType getContract()

 <?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>Supplier Consumption. Contract</ccts:DictionaryEntryName>
                      <ccts:Definition>A contract setting forth conditions regulating the consumption.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Supplier Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Contract</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Contract</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Contract</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is ContractType

setContract

public void setContract(ContractType value)

Sets the value of the contract property.

Parameters:

value - allowed object is ContractType

getConsumptionLine

public List<ConsumptionLineType> getConsumptionLine()

 <?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>Supplier Consumption. Consumption Line</ccts:DictionaryEntryName>
                      <ccts:Definition>The consumption of a utility product.</ccts:Definition>
                      <ccts:Cardinality>1..n</ccts:Cardinality>
                      <ccts:ObjectClass>Supplier Consumption</ccts:ObjectClass>
                      <ccts:PropertyTerm>Consumption Line</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Consumption Line</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Consumption Line</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getConsumptionLine().add(newItem);
 

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