oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class ConsumptionAverageType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.ConsumptionAverageType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class ConsumptionAverageType
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>Consumption Average. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define an average consumption as a monetary amount.</ccts:Definition><ccts:ObjectClass>Consumption Average</ccts:ObjectClass></ccts:Component>
 

Java class for ConsumptionAverageType complex type.

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

 <complexType name="ConsumptionAverageType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AverageAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" 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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsumptionAverageType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addDescription(DescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ConsumptionAverageType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ConsumptionAverageType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
AverageAmountType	getAverageAmount() <?
BigDecimal	getAverageAmountValue() Get the value of the contained AverageAmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<DescriptionType>	getDescription() <?
DescriptionType	getDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCount() 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	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setAverageAmount(AverageAmountType value) Sets the value of the averageAmount property.
AverageAmountType	setAverageAmount(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDescription(List<DescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
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

ConsumptionAverageType

public ConsumptionAverageType()

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

Method Detail

getAverageAmount

@Nullable
public AverageAmountType getAverageAmount()

 <?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 Average. Average_ Amount. Amount</ccts:DictionaryEntryName><ccts:Definition>The average monetary amount of the consumption.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption Average</ccts:ObjectClass><ccts:PropertyTermQualifier>Average</ccts:PropertyTermQualifier><ccts:PropertyTerm>Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType><ccts:Examples>1.65</ccts:Examples></ccts:Component>
 

Returns:

possible object is AverageAmountType

setAverageAmount

public void setAverageAmount(@Nullable
                             AverageAmountType value)

Sets the value of the averageAmount property.

Parameters:

value - allowed object is AverageAmountType

getDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
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 Average. Description. Text</ccts:DictionaryEntryName><ccts:Definition>A description of the average consumed.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Consumption Average</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>Average price incl. value added tax per kilowatt-hour in the billing period.</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

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 null.

hasDescriptionEntries

public boolean hasDescriptionEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoDescriptionEntries

public boolean hasNoDescriptionEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false 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 null

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 null.

cloneTo

public void cloneTo(@Nonnull
                    ConsumptionAverageType ret)

This method clones all values from this 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 null.

clone

@Nonnull
 @ReturnsMutableCopy
public ConsumptionAverageType 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 null.

setAverageAmount

@Nonnull
public AverageAmountType setAverageAmount(@Nullable
                                                    BigDecimal valueParam)

Special setter with value of type BigDecimal
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type AverageAmountType and never null

getAverageAmountValue

@Nullable
public BigDecimal getAverageAmountValue()

Get the value of the contained AverageAmountType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained AverageAmountType object or null