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

Class ConsumptionLineType

java.lang.Object

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

public class ConsumptionLineType
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 Line. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a line item for utility consumption. To specify more than one utility item, use separate consumption lines.</ccts:Definition>
                <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ConsumptionLineType complex type.

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

 <complexType name="ConsumptionLineType">
   <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}ParentDocumentLineReferenceID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}InvoicedQuantity"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LineExtensionAmount"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Period" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Delivery" maxOccurs="unbounded" 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}UtilityItem"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Price" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}UnstructuredPrice" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AllowanceChargeType>	allowanceCharge
protected List<DeliveryType>	delivery
protected IDType	id
protected InvoicedQuantityType	invoicedQuantity
protected LineExtensionAmountType	lineExtensionAmount
protected ParentDocumentLineReferenceIDType	parentDocumentLineReferenceID
protected PeriodType	period
protected PriceType	price
protected List<TaxTotalType>	taxTotal
protected UnstructuredPriceType	unstructuredPrice
protected UtilityItemType	utilityItem

Constructor Summary

Constructors

Constructor and Description
ConsumptionLineType()

Method Summary

Modifier and Type	Method and Description
List<AllowanceChargeType>	getAllowanceCharge() <?
List<DeliveryType>	getDelivery() <?
IDType	getID() <?
InvoicedQuantityType	getInvoicedQuantity() <?
LineExtensionAmountType	getLineExtensionAmount() <?
ParentDocumentLineReferenceIDType	getParentDocumentLineReferenceID() <?
PeriodType	getPeriod() <?
PriceType	getPrice() <?
List<TaxTotalType>	getTaxTotal() <?
UnstructuredPriceType	getUnstructuredPrice() <?
UtilityItemType	getUtilityItem() <?
void	setID(IDType value) Sets the value of the id property.
void	setInvoicedQuantity(InvoicedQuantityType value) Sets the value of the invoicedQuantity property.
void	setLineExtensionAmount(LineExtensionAmountType value) Sets the value of the lineExtensionAmount property.
void	setParentDocumentLineReferenceID(ParentDocumentLineReferenceIDType value) Sets the value of the parentDocumentLineReferenceID property.
void	setPeriod(PeriodType value) Sets the value of the period property.
void	setPrice(PriceType value) Sets the value of the price property.
void	setUnstructuredPrice(UnstructuredPriceType value) Sets the value of the unstructuredPrice property.
void	setUtilityItem(UtilityItemType value) Sets the value of the utilityItem 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

parentDocumentLineReferenceID

protected ParentDocumentLineReferenceIDType parentDocumentLineReferenceID

invoicedQuantity

protected InvoicedQuantityType invoicedQuantity

lineExtensionAmount

protected LineExtensionAmountType lineExtensionAmount

period

protected PeriodType period

delivery

protected List<DeliveryType> delivery

allowanceCharge

protected List<AllowanceChargeType> allowanceCharge

taxTotal

protected List<TaxTotalType> taxTotal

utilityItem

protected UtilityItemType utilityItem

price

protected PriceType price

unstructuredPrice

protected UnstructuredPriceType unstructuredPrice

Constructor Detail

ConsumptionLineType

public ConsumptionLineType()

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

getParentDocumentLineReferenceID

public ParentDocumentLineReferenceIDType getParentDocumentLineReferenceID()

 <?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 Line. Parent_ Document Line Reference Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for the transaction line on a related document (such as an invoice) that covers this consumption line.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Parent</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Document Line Reference Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>Consumption</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is ParentDocumentLineReferenceIDType

setParentDocumentLineReferenceID

public void setParentDocumentLineReferenceID(ParentDocumentLineReferenceIDType value)

Sets the value of the parentDocumentLineReferenceID property.

Parameters:

value - allowed object is ParentDocumentLineReferenceIDType

getInvoicedQuantity

public InvoicedQuantityType getInvoicedQuantity()

 <?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 Line. Invoiced_ Quantity. Quantity</ccts:DictionaryEntryName>
                      <ccts:Definition>The quantity invoiced.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Invoiced</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Quantity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm>
                      <ccts:DataType>Quantity. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is InvoicedQuantityType

setInvoicedQuantity

public void setInvoicedQuantity(InvoicedQuantityType value)

Sets the value of the invoicedQuantity property.

Parameters:

value - allowed object is InvoicedQuantityType

getLineExtensionAmount

public LineExtensionAmountType getLineExtensionAmount()

 <?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 Line. Line Extension Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The monetary amount, including discount, to be charged for this consumption line.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Line Extension Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is LineExtensionAmountType

setLineExtensionAmount

public void setLineExtensionAmount(LineExtensionAmountType value)

Sets the value of the lineExtensionAmount property.

Parameters:

value - allowed object is LineExtensionAmountType

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 Line. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period of time covered by this consumption line.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</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

getDelivery

public List<DeliveryType> getDelivery()

 <?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 Line. Delivery</ccts:DictionaryEntryName>
                      <ccts:Definition>A delivery of the utility item on this consumption line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Delivery</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Delivery</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Delivery</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getDelivery().add(newItem);
 

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

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 Line. Allowance Charge</ccts:DictionaryEntryName>
                      <ccts:Definition>An allowance or charge that applies to this consumption line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</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 Line. Tax Total</ccts:DictionaryEntryName>
                      <ccts:Definition>A total amount of taxes of a particular kind applicable to this consumption line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</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

getUtilityItem

public UtilityItemType getUtilityItem()

 <?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 Line. Utility Item</ccts:DictionaryEntryName>
                      <ccts:Definition>The utility item consumed.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Utility Item</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Utility Item</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Utility Item</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is UtilityItemType

setUtilityItem

public void setUtilityItem(UtilityItemType value)

Sets the value of the utilityItem property.

Parameters:

value - allowed object is UtilityItemType

getPrice

public PriceType getPrice()

 <?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 Line. Price</ccts:DictionaryEntryName>
                      <ccts:Definition>The price associated with this consumption line, expressed in a data structure containing multiple properties.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Price</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Price</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Price</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PriceType

setPrice

public void setPrice(PriceType value)

Sets the value of the price property.

Parameters:

value - allowed object is PriceType

getUnstructuredPrice

public UnstructuredPriceType getUnstructuredPrice()

 <?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 Line. Unstructured Price</ccts:DictionaryEntryName>
                      <ccts:Definition>The price associated with this consumption line expressed in a less structured form that includes just the amount and the time of use.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Consumption Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Unstructured Price</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Unstructured Price</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Unstructured Price</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is UnstructuredPriceType

setUnstructuredPrice

public void setUnstructuredPrice(UnstructuredPriceType value)

Sets the value of the unstructuredPrice property.

Parameters:

value - allowed object is UnstructuredPriceType