SupplierConsumptionType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.SupplierConsumptionType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class SupplierConsumptionType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre> Java class for SupplierConsumptionType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <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> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-list-extension This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SupplierConsumptionType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`SupplierConsumptionType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConsumptionLine(ConsumptionLineType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addDescription(DescriptionType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`SupplierConsumptionType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(SupplierConsumptionType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`ConsumptionType`	`getConsumption()` <pre> <?
`List<ConsumptionLineType>`	`getConsumptionLine()` <pre> <?
`ConsumptionLineType`	`getConsumptionLineAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getConsumptionLineCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`ContractType`	`getContract()` <pre> <?
`List<DescriptionType>`	`getDescription()` <pre> <?
`DescriptionType`	`getDescriptionAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getDescriptionCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`PartyType`	`getUtilityCustomerParty()` <pre> <?
`PartyType`	`getUtilitySupplierParty()` <pre> <?
`boolean`	`hasConsumptionLineEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoConsumptionLineEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setConsumption(ConsumptionType value)` Sets the value of the consumption property.
`void`	`setConsumptionLine(List<ConsumptionLineType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setContract(ContractType value)` Sets the value of the contract property.
`void`	`setDescription(List<DescriptionType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setUtilityCustomerParty(PartyType value)` Sets the value of the utilityCustomerParty property.
`void`	`setUtilitySupplierParty(PartyType value)` Sets the value of the utilitySupplierParty property.
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - SupplierConsumptionType
```
public SupplierConsumptionType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getDescription
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionType> getDescription()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre> 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 <CODE>set</CODE> method for the description property. For example, to add a new item, do as follows: <pre> getDescription().add(newItem); </pre> Objects of the following type(s) are allowed in the list DescriptionType
 - getUtilitySupplierParty
```
@Nullable
public PartyType getUtilitySupplierParty()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre>
 
 Returns:
 
 possible object is PartyType
 - setUtilitySupplierParty
```
public void setUtilitySupplierParty(@Nullable
 PartyType value)
```
 Sets the value of the utilitySupplierParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getUtilityCustomerParty
```
@Nullable
public PartyType getUtilityCustomerParty()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre>
 
 Returns:
 
 possible object is PartyType
 - setUtilityCustomerParty
```
public void setUtilityCustomerParty(@Nullable
 PartyType value)
```
 Sets the value of the utilityCustomerParty property.
 
 Parameters:
 
 value - allowed object is PartyType
 - getConsumption
```
@Nullable
public ConsumptionType getConsumption()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre>
 
 Returns:
 
 possible object is ConsumptionType
 - setConsumption
```
public void setConsumption(@Nullable
 ConsumptionType value)
```
 Sets the value of the consumption property.
 
 Parameters:
 
 value - allowed object is ConsumptionType
 - getContract
```
@Nullable
public ContractType getContract()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre>
 
 Returns:
 
 possible object is ContractType
 - setContract
```
public void setContract(@Nullable
 ContractType value)
```
 Sets the value of the contract property.
 
 Parameters:
 
 value - allowed object is ContractType
 - getConsumptionLine
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ConsumptionLineType> getConsumptionLine()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" 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> </pre> 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 <CODE>set</CODE> method for the consumptionLine property. For example, to add a new item, do as follows: <pre> getConsumptionLine().add(newItem); </pre> Objects of the following type(s) are allowed in the list ConsumptionLineType
 - equals
```
public boolean equals(Object o)
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Created by ph-jaxb22-plugin -Xph-tostring
 
 Overrides:
 
 toString in class Object
 - setDescription
```
public void setDescription(@Nullable
 List<DescriptionType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - setConsumptionLine
```
public void setConsumptionLine(@Nullable
 List<ConsumptionLineType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasDescriptionEntries
```
public boolean hasDescriptionEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoDescriptionEntries
```
public boolean hasNoDescriptionEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getDescriptionCount
```
@Nonnegative
public int getDescriptionCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getDescriptionAtIndex
```
@Nullable
public DescriptionType getDescriptionAtIndex(@Nonnegative
 int index)
 throws IndexOutOfBoundsException
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 index - The index to retrieve
 
 Returns:
 
 The element at the specified index. May be <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addDescription
```
public void addDescription(@Nonnull
 DescriptionType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - hasConsumptionLineEntries
```
public boolean hasConsumptionLineEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoConsumptionLineEntries
```
public boolean hasNoConsumptionLineEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getConsumptionLineCount
```
@Nonnegative
public int getConsumptionLineCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getConsumptionLineAtIndex
```
@Nullable
public ConsumptionLineType getConsumptionLineAtIndex(@Nonnegative
 int index)
 throws IndexOutOfBoundsException
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 index - The index to retrieve
 
 Returns:
 
 The element at the specified index. May be <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addConsumptionLine
```
public void addConsumptionLine(@Nonnull
 ConsumptionLineType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 SupplierConsumptionType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public SupplierConsumptionType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.

Class SupplierConsumptionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SupplierConsumptionType

Method Detail

getDescription

getUtilitySupplierParty

setUtilitySupplierParty

getUtilityCustomerParty

setUtilityCustomerParty

getConsumption

setConsumption

getContract

setContract

getConsumptionLine

equals

hashCode

toString

setDescription

setConsumptionLine

hasDescriptionEntries

hasNoDescriptionEntries

getDescriptionCount

getDescriptionAtIndex

addDescription

hasConsumptionLineEntries

hasNoConsumptionLineEntries

getConsumptionLineCount

getConsumptionLineAtIndex

addConsumptionLine

cloneTo

clone