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

Class ItemIdentificationType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ItemIdentificationType
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>Item Identification. Details</ccts:DictionaryEntryName><ccts:Definition>A class for assigning identifying information to an item.</ccts:Definition><ccts:ObjectClass>Item Identification</ccts:ObjectClass></ccts:Component>
 

Java class for ItemIdentificationType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addMeasurementDimension(DimensionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addPhysicalAttribute(PhysicalAttributeType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ItemIdentificationType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ItemIdentificationType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
BarcodeSymbologyIDType	getBarcodeSymbologyID() <?
String	getBarcodeSymbologyIDValue() Get the value of the contained BarcodeSymbologyIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ExtendedIDType	getExtendedID() <?
String	getExtendedIDValue() Get the value of the contained ExtendedIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PartyType	getIssuerParty() <?
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
List<PhysicalAttributeType>	getPhysicalAttribute() <?
PhysicalAttributeType	getPhysicalAttributeAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getPhysicalAttributeCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasMeasurementDimensionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoMeasurementDimensionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoPhysicalAttributeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasPhysicalAttributeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setBarcodeSymbologyID(BarcodeSymbologyIDType value) Sets the value of the barcodeSymbologyID property.
BarcodeSymbologyIDType	setBarcodeSymbologyID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setExtendedID(ExtendedIDType value) Sets the value of the extendedID property.
ExtendedIDType	setExtendedID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setID(IDType value) Sets the value of the id property.
IDType	setID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setIssuerParty(PartyType value) Sets the value of the issuerParty property.
void	setMeasurementDimension(List<DimensionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setPhysicalAttribute(List<PhysicalAttributeType> 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

ItemIdentificationType

public ItemIdentificationType()

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

Method Detail

getID

@Nullable
public IDType getID()

 <?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>Item Identification. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the item.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Item Identification</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>CUST001 3333-44-123 </ccts:Examples></ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(@Nullable
                  IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getExtendedID

@Nullable
public ExtendedIDType getExtendedID()

 <?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>Item Identification. Extended_ Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An extended identifier for the item that identifies the item with specific properties, e.g., Item 123 = Chair / Item 123 Ext 45 = brown chair. Two chairs can have the same item number, but one is brown. The other is white.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Identification</ccts:ObjectClass><ccts:PropertyTermQualifier>Extended</ccts:PropertyTermQualifier><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ExtendedIDType

setExtendedID

public void setExtendedID(@Nullable
                          ExtendedIDType value)

Sets the value of the extendedID property.

Parameters:

value - allowed object is ExtendedIDType

getBarcodeSymbologyID

@Nullable
public BarcodeSymbologyIDType getBarcodeSymbologyID()

 <?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>Item Identification. Barcode_ Symbology Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for a system of barcodes.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Identification</ccts:ObjectClass><ccts:PropertyTermQualifier>Barcode</ccts:PropertyTermQualifier><ccts:PropertyTerm>Symbology Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is BarcodeSymbologyIDType

setBarcodeSymbologyID

public void setBarcodeSymbologyID(@Nullable
                                  BarcodeSymbologyIDType value)

Sets the value of the barcodeSymbologyID property.

Parameters:

value - allowed object is BarcodeSymbologyIDType

getPhysicalAttribute

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PhysicalAttributeType> getPhysicalAttribute()

 <?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>Item Identification. Physical Attribute</ccts:DictionaryEntryName><ccts:Definition>A physical attribute of the item.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Item Identification</ccts:ObjectClass><ccts:PropertyTerm>Physical Attribute</ccts:PropertyTerm><ccts:AssociatedObjectClass>Physical Attribute</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Physical Attribute</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getPhysicalAttribute().add(newItem);
 

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

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>Item Identification. Measurement_ Dimension. Dimension</ccts:DictionaryEntryName><ccts:Definition>A measurable dimension (length, mass, weight, or volume) of the item.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Item Identification</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

getIssuerParty

@Nullable
public PartyType getIssuerParty()

 <?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>Item Identification. Issuer_ Party. Party</ccts:DictionaryEntryName><ccts:Definition>The party that issued this item identification.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Identification</ccts:ObjectClass><ccts:PropertyTermQualifier>Issuer</ccts:PropertyTermQualifier><ccts:PropertyTerm>Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Party</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PartyType

setIssuerParty

public void setIssuerParty(@Nullable
                           PartyType value)

Sets the value of the issuerParty property.

Parameters:

value - allowed object is PartyType

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

setPhysicalAttribute

public void setPhysicalAttribute(@Nullable
                                 List<PhysicalAttributeType> 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.

hasPhysicalAttributeEntries

public boolean hasPhysicalAttributeEntries()

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

Returns:

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

hasNoPhysicalAttributeEntries

public boolean hasNoPhysicalAttributeEntries()

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

Returns:

true if no item is contained, false otherwise.

getPhysicalAttributeCount

@Nonnegative
public int getPhysicalAttributeCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getPhysicalAttributeAtIndex

@Nullable
public PhysicalAttributeType getPhysicalAttributeAtIndex(@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!

addPhysicalAttribute

public void addPhysicalAttribute(@Nonnull
                                 PhysicalAttributeType 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
                    ItemIdentificationType 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 ItemIdentificationType 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.

setID

@Nonnull
public IDType setID(@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 IDType and never null

setExtendedID

@Nonnull
public ExtendedIDType setExtendedID(@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 ExtendedIDType and never null

setBarcodeSymbologyID

@Nonnull
public BarcodeSymbologyIDType setBarcodeSymbologyID(@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 BarcodeSymbologyIDType and never null

getIDValue

@Nullable
public String getIDValue()

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

Returns:

Either the value of the contained IDType object or null

getExtendedIDValue

@Nullable
public String getExtendedIDValue()

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

Returns:

Either the value of the contained ExtendedIDType object or null

getBarcodeSymbologyIDValue

@Nullable
public String getBarcodeSymbologyIDValue()

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

Returns:

Either the value of the contained BarcodeSymbologyIDType object or null