@CodingStyleguideUnaware public class SubscriberConsumptionType extends Object implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
<?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>
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
| Constructor and Description |
|---|
SubscriberConsumptionType()
Default constructor
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
| Modifier and Type | Method and Description |
|---|---|
void |
addNote(NoteType elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
addOnAccountPayment(OnAccountPaymentType elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
addSupplierConsumption(SupplierConsumptionType elem)
Created by ph-jaxb22-plugin -Xph-list-extension
|
SubscriberConsumptionType |
clone()
Created by ph-jaxb22-plugin -Xph-cloneable2
|
void |
cloneTo(SubscriberConsumptionType ret)
This method clones all values from
this to the passed object. |
boolean |
equals(Object o)
Created by ph-jaxb22-plugin -Xph-equalshashcode
|
ConsumptionType |
getConsumption()
<?
|
ConsumptionIDType |
getConsumptionID()
<?
|
String |
getConsumptionIDValue()
Get the value of the contained ConsumptionIDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
List<NoteType> |
getNote()
<?
|
NoteType |
getNoteAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getNoteCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
List<OnAccountPaymentType> |
getOnAccountPayment()
<?
|
OnAccountPaymentType |
getOnAccountPaymentAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getOnAccountPaymentCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
SpecificationTypeCodeType |
getSpecificationTypeCode()
<?
|
String |
getSpecificationTypeCodeValue()
Get the value of the contained SpecificationTypeCodeType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
PartyType |
getSubscriberParty()
<?
|
List<SupplierConsumptionType> |
getSupplierConsumption()
<?
|
SupplierConsumptionType |
getSupplierConsumptionAtIndex(int index)
Created by ph-jaxb22-plugin -Xph-list-extension
|
int |
getSupplierConsumptionCount()
Created by ph-jaxb22-plugin -Xph-list-extension
|
TotalMeteredQuantityType |
getTotalMeteredQuantity()
<?
|
BigDecimal |
getTotalMeteredQuantityValue()
Get the value of the contained TotalMeteredQuantityType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
ConsumptionPointType |
getUtilityConsumptionPoint()
<?
|
int |
hashCode()
Created by ph-jaxb22-plugin -Xph-equalshashcode
|
boolean |
hasNoNoteEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasNoOnAccountPaymentEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasNoSupplierConsumptionEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasNoteEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasOnAccountPaymentEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
boolean |
hasSupplierConsumptionEntries()
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
setConsumption(ConsumptionType value)
Sets the value of the consumption property.
|
void |
setConsumptionID(ConsumptionIDType value)
Sets the value of the consumptionID property.
|
ConsumptionIDType |
setConsumptionID(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setNote(List<NoteType> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
setOnAccountPayment(List<OnAccountPaymentType> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
void |
setSpecificationTypeCode(SpecificationTypeCodeType value)
Sets the value of the specificationTypeCode property.
|
SpecificationTypeCodeType |
setSpecificationTypeCode(String valueParam)
Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setSubscriberParty(PartyType value)
Sets the value of the subscriberParty property.
|
void |
setSupplierConsumption(List<SupplierConsumptionType> aList)
Created by ph-jaxb22-plugin -Xph-list-extension
|
TotalMeteredQuantityType |
setTotalMeteredQuantity(BigDecimal valueParam)
Special setter with value of type BigDecimal
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender |
void |
setTotalMeteredQuantity(TotalMeteredQuantityType value)
Sets the value of the totalMeteredQuantity property.
|
void |
setUtilityConsumptionPoint(ConsumptionPointType value)
Sets the value of the utilityConsumptionPoint property.
|
String |
toString()
Created by ph-jaxb22-plugin -Xph-tostring
|
public SubscriberConsumptionType()
@Nullable 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>
ConsumptionIDTypepublic void setConsumptionID(@Nullable ConsumptionIDType value)
value - allowed object is
ConsumptionIDType@Nullable 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>
SpecificationTypeCodeTypepublic void setSpecificationTypeCode(@Nullable SpecificationTypeCodeType value)
value - allowed object is
SpecificationTypeCodeType@Nonnull @ReturnsMutableObject(value="JAXB implementation style") 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
@Nullable 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>
TotalMeteredQuantityTypepublic void setTotalMeteredQuantity(@Nullable TotalMeteredQuantityType value)
value - allowed object is
TotalMeteredQuantityType@Nullable 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>
PartyTypepublic void setSubscriberParty(@Nullable PartyType value)
value - allowed object is
PartyType@Nullable 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>
ConsumptionPointTypepublic void setUtilityConsumptionPoint(@Nullable ConsumptionPointType value)
value - allowed object is
ConsumptionPointType@Nonnull @ReturnsMutableObject(value="JAXB implementation style") 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
@Nullable 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>
ConsumptionTypepublic void setConsumption(@Nullable ConsumptionType value)
value - allowed object is
ConsumptionType@Nonnull @ReturnsMutableObject(value="JAXB implementation style") 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
public boolean equals(Object o)
public int hashCode()
public String toString()
public void setNote(@Nullable List<NoteType> aList)
aList - The new list member to set. May be null.public void setOnAccountPayment(@Nullable List<OnAccountPaymentType> aList)
aList - The new list member to set. May be null.public void setSupplierConsumption(@Nullable List<SupplierConsumptionType> aList)
aList - The new list member to set. May be null.public boolean hasNoteEntries()
true if at least one item is contained, false otherwise.public boolean hasNoNoteEntries()
true if no item is contained, false otherwise.@Nonnegative public int getNoteCount()
@Nullable public NoteType getNoteAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addNote(@Nonnull NoteType elem)
elem - The element to be added. May not be null.public boolean hasOnAccountPaymentEntries()
true if at least one item is contained, false otherwise.public boolean hasNoOnAccountPaymentEntries()
true if no item is contained, false otherwise.@Nonnegative public int getOnAccountPaymentCount()
@Nullable public OnAccountPaymentType getOnAccountPaymentAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addOnAccountPayment(@Nonnull OnAccountPaymentType elem)
elem - The element to be added. May not be null.public boolean hasSupplierConsumptionEntries()
true if at least one item is contained, false otherwise.public boolean hasNoSupplierConsumptionEntries()
true if no item is contained, false otherwise.@Nonnegative public int getSupplierConsumptionCount()
@Nullable public SupplierConsumptionType getSupplierConsumptionAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
index - The index to retrievenullIndexOutOfBoundsException - if the index is invalid!public void addSupplierConsumption(@Nonnull SupplierConsumptionType elem)
elem - The element to be added. May not be null.public void cloneTo(@Nonnull SubscriberConsumptionType ret)
this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2ret - The target object to clone to. May not be null.@Nonnull @ReturnsMutableCopy public SubscriberConsumptionType clone()
@Nonnull public SpecificationTypeCodeType setSpecificationTypeCode(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public ConsumptionIDType setConsumptionID(@Nullable String valueParam)
valueParam - The value to be set. May be null.null@Nonnull public TotalMeteredQuantityType setTotalMeteredQuantity(@Nullable BigDecimal valueParam)
valueParam - The value to be set. May be null.null@Nullable public String getConsumptionIDValue()
null@Nullable public String getSpecificationTypeCodeValue()
null@Nullable public BigDecimal getTotalMeteredQuantityValue()
nullCopyright © 2014–2020 Philip Helger. All rights reserved.