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

Class ClassificationCategoryType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ClassificationCategoryType
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>Classification Category. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a category within a classification scheme.</ccts:Definition><ccts:ObjectClass>Classification Category</ccts:ObjectClass></ccts:Component>
 

Java class for ClassificationCategoryType complex type.

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

 <complexType name="ClassificationCategoryType">
   <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}CodeValue" 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:CommonAggregateComponents-2}CategorizesClassificationCategory" 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
ClassificationCategoryType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addCategorizesClassificationCategory(ClassificationCategoryType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addDescription(DescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ClassificationCategoryType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ClassificationCategoryType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<ClassificationCategoryType>	getCategorizesClassificationCategory() <?
ClassificationCategoryType	getCategorizesClassificationCategoryAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getCategorizesClassificationCategoryCount() Created by ph-jaxb22-plugin -Xph-list-extension
CodeValueType	getCodeValue() <?
String	getCodeValueValue() Get the value of the contained CodeValueType 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
NameType	getName() <?
String	getNameValue() Get the value of the contained NameType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasCategorizesClassificationCategoryEntries() 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	hasNoCategorizesClassificationCategoryEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setCategorizesClassificationCategory(List<ClassificationCategoryType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setCodeValue(CodeValueType value) Sets the value of the codeValue property.
CodeValueType	setCodeValue(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDescription(List<DescriptionType> aList) 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
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

ClassificationCategoryType

public ClassificationCategoryType()

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

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>Classification Category. Name</ccts:DictionaryEntryName><ccts:Definition>The name of this category within the classification scheme.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Classification Category</ccts:ObjectClass><ccts:PropertyTerm>Name</ccts:PropertyTerm><ccts:RepresentationTerm>Name</ccts:RepresentationTerm><ccts:DataType>Name. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Code List Name</ccts:AlternativeBusinessTerms><ccts:Examples>UNSPSC Class , UNSPSC Segment , UNSPSC Family </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

getCodeValue

@Nullable
public CodeValueType getCodeValue()

 <?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>Classification Category. Code Value. Text</ccts:DictionaryEntryName><ccts:Definition>The value of a code used to identify this category within the classification scheme.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Classification Category</ccts:ObjectClass><ccts:PropertyTerm>Code Value</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Code Value</ccts:AlternativeBusinessTerms><ccts:Examples>3420001, 3273666, HSJJD-213</ccts:Examples></ccts:Component>
 

Returns:

possible object is CodeValueType

setCodeValue

public void setCodeValue(@Nullable
                         CodeValueType value)

Sets the value of the codeValue property.

Parameters:

value - allowed object is CodeValueType

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>Classification Category. Description. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing this category.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Classification Category</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Code Name</ccts:AlternativeBusinessTerms><ccts:Examples>Electrical Goods , Wooden Toys </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

getCategorizesClassificationCategory

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ClassificationCategoryType> getCategorizesClassificationCategory()

 <?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>Classification Category. Categorizes_ Classification Category. Classification Category</ccts:DictionaryEntryName><ccts:Definition>A recursive description of a subcategory of this category.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Classification Category</ccts:ObjectClass><ccts:PropertyTermQualifier>Categorizes</ccts:PropertyTermQualifier><ccts:PropertyTerm>Classification Category</ccts:PropertyTerm><ccts:AssociatedObjectClass>Classification Category</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Classification Category</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getCategorizesClassificationCategory().add(newItem);
 

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

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.

setCategorizesClassificationCategory

public void setCategorizesClassificationCategory(@Nullable
                                                 List<ClassificationCategoryType> 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.

hasCategorizesClassificationCategoryEntries

public boolean hasCategorizesClassificationCategoryEntries()

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

Returns:

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

hasNoCategorizesClassificationCategoryEntries

public boolean hasNoCategorizesClassificationCategoryEntries()

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

Returns:

true if no item is contained, false otherwise.

getCategorizesClassificationCategoryCount

@Nonnegative
public int getCategorizesClassificationCategoryCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getCategorizesClassificationCategoryAtIndex

@Nullable
public ClassificationCategoryType getCategorizesClassificationCategoryAtIndex(@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!

addCategorizesClassificationCategory

public void addCategorizesClassificationCategory(@Nonnull
                                                 ClassificationCategoryType 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
                    ClassificationCategoryType 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 ClassificationCategoryType 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.

setCodeValue

@Nonnull
public CodeValueType setCodeValue(@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 CodeValueType 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

getCodeValueValue

@Nullable
public String getCodeValueValue()

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

Returns:

Either the value of the contained CodeValueType object or null