DimensionType (ph-ubl22 6.7.0 API)

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

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class DimensionType
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>Dimension. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a measurable dimension (length, mass, weight, volume, or area) of an item.</ccts:Definition><ccts:ObjectClass>Dimension</ccts:ObjectClass></ccts:Component> </pre> Java class for DimensionType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="DimensionType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AttributeID"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Measure" minOccurs="0"/> <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:CommonBasicComponents-2}MinimumMeasure" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MaximumMeasure" minOccurs="0"/> </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

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

Constructors
Constructor and Description
`DimensionType()` 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`	`addDescription(DescriptionType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`DimensionType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(DimensionType 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
`AttributeIDType`	`getAttributeID()` <pre> <?
`String`	`getAttributeIDValue()` Get the value of the contained AttributeIDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`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
`MaximumMeasureType`	`getMaximumMeasure()` <pre> <?
`BigDecimal`	`getMaximumMeasureValue()` Get the value of the contained MaximumMeasureType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`MeasureType`	`getMeasure()` <pre> <?
`BigDecimal`	`getMeasureValue()` Get the value of the contained MeasureType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`MinimumMeasureType`	`getMinimumMeasure()` <pre> <?
`BigDecimal`	`getMinimumMeasureValue()` Get the value of the contained MinimumMeasureType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`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`	`setAttributeID(AttributeIDType value)` Sets the value of the attributeID property.
`AttributeIDType`	`setAttributeID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setDescription(List<DescriptionType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`MaximumMeasureType`	`setMaximumMeasure(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setMaximumMeasure(MaximumMeasureType value)` Sets the value of the maximumMeasure property.
`MeasureType`	`setMeasure(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setMeasure(MeasureType value)` Sets the value of the measure property.
`MinimumMeasureType`	`setMinimumMeasure(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setMinimumMeasure(MinimumMeasureType value)` Sets the value of the minimumMeasure 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
 - DimensionType
```
public DimensionType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getAttributeID
```
@Nullable
public AttributeIDType getAttributeID()
```
 <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>Dimension. Attribute Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the attribute to which the measure applies.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Attribute Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is AttributeIDType
 - setAttributeID
```
public void setAttributeID(@Nullable
 AttributeIDType value)
```
 Sets the value of the attributeID property.
 
 Parameters:
 
 value - allowed object is AttributeIDType
 - getMeasure
```
@Nullable
public MeasureType getMeasure()
```
 <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>Dimension. Measure</ccts:DictionaryEntryName><ccts:Definition>The measurement value.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is MeasureType
 - setMeasure
```
public void setMeasure(@Nullable
 MeasureType value)
```
 Sets the value of the measure property.
 
 Parameters:
 
 value - allowed object is MeasureType
 - 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>Dimension. Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the measurement attribute.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></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
 - getMinimumMeasure
```
@Nullable
public MinimumMeasureType getMinimumMeasure()
```
 <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>Dimension. Minimum_ Measure. Measure</ccts:DictionaryEntryName><ccts:Definition>The minimum value in a range of measurement of this dimension.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTermQualifier>Minimum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is MinimumMeasureType
 - setMinimumMeasure
```
public void setMinimumMeasure(@Nullable
 MinimumMeasureType value)
```
 Sets the value of the minimumMeasure property.
 
 Parameters:
 
 value - allowed object is MinimumMeasureType
 - getMaximumMeasure
```
@Nullable
public MaximumMeasureType getMaximumMeasure()
```
 <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>Dimension. Maximum_ Measure. Measure</ccts:DictionaryEntryName><ccts:Definition>The maximum value in a range of measurement of this dimension.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Dimension</ccts:ObjectClass><ccts:PropertyTermQualifier>Maximum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Measure</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is MaximumMeasureType
 - setMaximumMeasure
```
public void setMaximumMeasure(@Nullable
 MaximumMeasureType value)
```
 Sets the value of the maximumMeasure property.
 
 Parameters:
 
 value - allowed object is MaximumMeasureType
 - 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>.
 - 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>.
 - cloneTo
```
public void cloneTo(@Nonnull
 DimensionType 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 DimensionType 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>.
 - setAttributeID
```
@Nonnull
public AttributeIDType setAttributeID(@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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type AttributeIDType and never <code>null</code>
 - setMeasure
```
@Nonnull
public MeasureType setMeasure(@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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type MeasureType and never <code>null</code>
 - setMinimumMeasure
```
@Nonnull
public MinimumMeasureType setMinimumMeasure(@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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type MinimumMeasureType and never <code>null</code>
 - setMaximumMeasure
```
@Nonnull
public MaximumMeasureType setMaximumMeasure(@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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type MaximumMeasureType and never <code>null</code>
 - getAttributeIDValue
```
@Nullable
public String getAttributeIDValue()
```
 Get the value of the contained AttributeIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained AttributeIDType object or <code>null</code>
 - getMeasureValue
```
@Nullable
public BigDecimal getMeasureValue()
```
 Get the value of the contained MeasureType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained MeasureType object or <code>null</code>
 - getMinimumMeasureValue
```
@Nullable
public BigDecimal getMinimumMeasureValue()
```
 Get the value of the contained MinimumMeasureType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained MinimumMeasureType object or <code>null</code>
 - getMaximumMeasureValue
```
@Nullable
public BigDecimal getMaximumMeasureValue()
```
 Get the value of the contained MaximumMeasureType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained MaximumMeasureType object or <code>null</code>

Class DimensionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DimensionType

Method Detail

getAttributeID

setAttributeID

getMeasure

setMeasure

getDescription

getMinimumMeasure

setMinimumMeasure

getMaximumMeasure

setMaximumMeasure

equals

hashCode

toString

setDescription

hasDescriptionEntries

hasNoDescriptionEntries

getDescriptionCount

getDescriptionAtIndex

addDescription

cloneTo

clone

setAttributeID

setMeasure

setMinimumMeasure

setMaximumMeasure

getAttributeIDValue

getMeasureValue

getMinimumMeasureValue

getMaximumMeasureValue