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

Class MeterPropertyType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class MeterPropertyType
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>Meter Property. Details</ccts:DictionaryEntryName><ccts:Definition>The name of this meter property.</ccts:Definition><ccts:ObjectClass>Meter Property</ccts:ObjectClass></ccts:Component>
 

Java class for MeterPropertyType complex type.

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

 <complexType name="MeterPropertyType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}NameCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Value" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ValueQuantity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ValueQualifier" 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
MeterPropertyType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
MeterPropertyType(ValueType valueParam) Constructor for value of type ValueType Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addValueQualifier(ValueQualifierType elem) Created by ph-jaxb22-plugin -Xph-list-extension
MeterPropertyType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(MeterPropertyType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
NameType	getName() <?
NameCodeType	getNameCode() <?
String	getNameCodeValue() Get the value of the contained NameCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
String	getNameValue() Get the value of the contained NameType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ValueType	getValue() <?
List<ValueQualifierType>	getValueQualifier() <?
ValueQualifierType	getValueQualifierAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getValueQualifierCount() Created by ph-jaxb22-plugin -Xph-list-extension
ValueQuantityType	getValueQuantity() <?
BigDecimal	getValueQuantityValue() Get the value of the contained ValueQuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
String	getValueValue() Get the value of the contained ValueType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoValueQualifierEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasValueQualifierEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setName(NameType value) Sets the value of the name property.
NameType	setName(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setNameCode(NameCodeType value) Sets the value of the nameCode property.
NameCodeType	setNameCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ValueType	setValue(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setValue(ValueType value) Sets the value of the value property.
void	setValueQualifier(List<ValueQualifierType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
ValueQuantityType	setValueQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setValueQuantity(ValueQuantityType value) Sets the value of the valueQuantity 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

MeterPropertyType

public MeterPropertyType()

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

MeterPropertyType

public MeterPropertyType(@Nullable
                         ValueType valueParam)

Constructor for value of type ValueType
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

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

Method Detail

getName

@Nullable
public NameType getName()

 <?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>Meter Property. Name</ccts:DictionaryEntryName><ccts:Definition>The name of this meter property, expressed as a code.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Meter Property</ccts:ObjectClass><ccts:PropertyTerm>Name</ccts:PropertyTerm><ccts:RepresentationTerm>Name</ccts:RepresentationTerm><ccts:DataType>Name. Type</ccts:DataType><ccts:Examples>Energy Rating , Collar Size , Fat Content </ccts:Examples></ccts:Component>
 

Returns:

possible object is NameType

setName

public void setName(@Nullable
                    NameType value)

Sets the value of the name property.

Parameters:

value - allowed object is NameType

getNameCode

@Nullable
public NameCodeType getNameCode()

 <?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>Meter Property. Name Code. Code</ccts:DictionaryEntryName><ccts:Definition>The value of this meter property, expressed as text.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Meter Property</ccts:ObjectClass><ccts:PropertyTerm>Name Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is NameCodeType

setNameCode

public void setNameCode(@Nullable
                        NameCodeType value)

Sets the value of the nameCode property.

Parameters:

value - allowed object is NameCodeType

getValue

@Nullable
public ValueType getValue()

 <?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>Meter Property. Value. Text</ccts:DictionaryEntryName><ccts:Definition>The value of this meter property, expressed as a quantity.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Meter Property</ccts:ObjectClass><ccts:PropertyTerm>Value</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>100 watts , 15 European , 20% +/- 5% </ccts:Examples></ccts:Component>
 

Returns:

possible object is ValueType

setValue

public void setValue(@Nullable
                     ValueType value)

Sets the value of the value property.

Parameters:

value - allowed object is ValueType

getValueQuantity

@Nullable
public ValueQuantityType getValueQuantity()

 <?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>Meter Property. Value_ Quantity. Quantity</ccts:DictionaryEntryName><ccts:Definition>The value of this meter property, expressed as a quantity.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Meter Property</ccts:ObjectClass><ccts:PropertyTermQualifier>Value</ccts:PropertyTermQualifier><ccts:PropertyTerm>Quantity</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ValueQuantityType

setValueQuantity

public void setValueQuantity(@Nullable
                             ValueQuantityType value)

Sets the value of the valueQuantity property.

Parameters:

value - allowed object is ValueQuantityType

getValueQualifier

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ValueQualifierType> getValueQualifier()

 <?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>Meter Property. Value Qualifier. Text</ccts:DictionaryEntryName><ccts:Definition>An additional value to qualify the value of the meter</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Meter Property</ccts:ObjectClass><ccts:PropertyTerm>Value Qualifier</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getValueQualifier().add(newItem);
 

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

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

setValueQualifier

public void setValueQualifier(@Nullable
                              List<ValueQualifierType> aList)

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

Parameters:

aList - The new list member to set. May be null.

hasValueQualifierEntries

public boolean hasValueQualifierEntries()

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

Returns:

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

hasNoValueQualifierEntries

public boolean hasNoValueQualifierEntries()

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

Returns:

true if no item is contained, false otherwise.

getValueQualifierCount

@Nonnegative
public int getValueQualifierCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getValueQualifierAtIndex

@Nullable
public ValueQualifierType getValueQualifierAtIndex(@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!

addValueQualifier

public void addValueQualifier(@Nonnull
                              ValueQualifierType 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
                    MeterPropertyType 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 MeterPropertyType 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.

setNameCode

@Nonnull
public NameCodeType setNameCode(@Nullable
                                          String valueParam)

Special setter with value of type String
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 NameCodeType and never null

setValueQuantity

@Nonnull
public ValueQuantityType setValueQuantity(@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 ValueQuantityType and never null

setValue

@Nonnull
public ValueType setValue(@Nullable
                                    String valueParam)

Special setter with value of type String
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 ValueType and never null

setName

@Nonnull
public NameType setName(@Nullable
                                  String valueParam)

Special setter with value of type String
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 NameType and never null

getNameValue

@Nullable
public String getNameValue()

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

Returns:

Either the value of the contained NameType object or null

getNameCodeValue

@Nullable
public String getNameCodeValue()

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

Returns:

Either the value of the contained NameCodeType object or null

getValueValue

@Nullable
public String getValueValue()

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

Returns:

Either the value of the contained ValueType object or null

getValueQuantityValue

@Nullable
public BigDecimal getValueQuantityValue()

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

Returns:

Either the value of the contained ValueQuantityType object or null