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

Class StowageType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class StowageType
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>Stowage. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a location on board a means of transport where specified goods or transport equipment have been stowed or are to be stowed.</ccts:Definition><ccts:ObjectClass>Stowage</ccts:ObjectClass></ccts:Component>
 

Java class for StowageType complex type.

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

 <complexType name="StowageType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LocationID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Location" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}MeasurementDimension" 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
StowageType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addLocation(LocationType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addMeasurementDimension(DimensionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
StowageType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(StowageType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<LocationType>	getLocation() <?
LocationType	getLocationAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getLocationCount() Created by ph-jaxb22-plugin -Xph-list-extension
LocationIDType	getLocationID() <?
String	getLocationIDValue() Get the value of the contained LocationIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<DimensionType>	getMeasurementDimension() <?
DimensionType	getMeasurementDimensionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getMeasurementDimensionCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasLocationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasMeasurementDimensionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoLocationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoMeasurementDimensionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setLocation(List<LocationType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setLocationID(LocationIDType value) Sets the value of the locationID property.
LocationIDType	setLocationID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setMeasurementDimension(List<DimensionType> 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

StowageType

public StowageType()

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

Method Detail

getLocationID

@Nullable
public LocationIDType getLocationID()

 <?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>Stowage. Location Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the location.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Stowage</ccts:ObjectClass><ccts:PropertyTerm>Location Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Cell Location, coded</ccts:AlternativeBusinessTerms></ccts:Component>
 

Returns:

possible object is LocationIDType

setLocationID

public void setLocationID(@Nullable
                          LocationIDType value)

Sets the value of the locationID property.

Parameters:

value - allowed object is LocationIDType

getLocation

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<LocationType> getLocation()

 <?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>Stowage. Location. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the location.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Stowage</ccts:ObjectClass><ccts:PropertyTerm>Location</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Cell Location</ccts:AlternativeBusinessTerms></ccts:Component>
 

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

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

    getLocation().add(newItem);
 

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

getMeasurementDimension

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DimensionType> getMeasurementDimension()

 <?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>Stowage. Measurement_ Dimension. Dimension</ccts:DictionaryEntryName><ccts:Definition>A measurable dimension (length, mass, weight, or volume) of this stowage.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Stowage</ccts:ObjectClass><ccts:PropertyTermQualifier>Measurement</ccts:PropertyTermQualifier><ccts:PropertyTerm>Dimension</ccts:PropertyTerm><ccts:AssociatedObjectClass>Dimension</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Dimension</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getMeasurementDimension().add(newItem);
 

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

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

setLocation

public void setLocation(@Nullable
                        List<LocationType> aList)

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

Parameters:

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

setMeasurementDimension

public void setMeasurementDimension(@Nullable
                                    List<DimensionType> aList)

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

Parameters:

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

hasLocationEntries

public boolean hasLocationEntries()

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

Returns:

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

hasNoLocationEntries

public boolean hasNoLocationEntries()

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

Returns:

true if no item is contained, false otherwise.

getLocationCount

@Nonnegative
public int getLocationCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getLocationAtIndex

@Nullable
public LocationType getLocationAtIndex(@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!

addLocation

public void addLocation(@Nonnull
                        LocationType elem)

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

Parameters:

elem - The element to be added. May not be null.

hasMeasurementDimensionEntries

public boolean hasMeasurementDimensionEntries()

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

Returns:

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

hasNoMeasurementDimensionEntries

public boolean hasNoMeasurementDimensionEntries()

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

Returns:

true if no item is contained, false otherwise.

getMeasurementDimensionCount

@Nonnegative
public int getMeasurementDimensionCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getMeasurementDimensionAtIndex

@Nullable
public DimensionType getMeasurementDimensionAtIndex(@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!

addMeasurementDimension

public void addMeasurementDimension(@Nonnull
                                    DimensionType 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
                    StowageType 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 StowageType 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.

setLocationID

@Nonnull
public LocationIDType setLocationID(@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 LocationIDType and never null

getLocationIDValue

@Nullable
public String getLocationIDValue()

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

Returns:

Either the value of the contained LocationIDType object or null