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

Class CatalogueRequestLineType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class CatalogueRequestLineType
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>Catalogue Request Line. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a line describing a request for a catalogue line.</ccts:Definition><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass></ccts:Component>
 

Java class for CatalogueRequestLineType complex type.

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

 <complexType name="CatalogueRequestLineType">
   <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}ContractSubdivision" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LineValidityPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}RequiredItemLocationQuantity" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Item"/>
       </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
CatalogueRequestLineType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addNote(NoteType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addRequiredItemLocationQuantity(ItemLocationQuantityType elem) Created by ph-jaxb22-plugin -Xph-list-extension
CatalogueRequestLineType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(CatalogueRequestLineType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
ContractSubdivisionType	getContractSubdivision() <?
String	getContractSubdivisionValue() Get the value of the contained ContractSubdivisionType 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
ItemType	getItem() <?
PeriodType	getLineValidityPeriod() <?
List<NoteType>	getNote() <?
NoteType	getNoteAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getNoteCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<ItemLocationQuantityType>	getRequiredItemLocationQuantity() <?
ItemLocationQuantityType	getRequiredItemLocationQuantityAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getRequiredItemLocationQuantityCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoNoteEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoRequiredItemLocationQuantityEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoteEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasRequiredItemLocationQuantityEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setContractSubdivision(ContractSubdivisionType value) Sets the value of the contractSubdivision property.
ContractSubdivisionType	setContractSubdivision(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	setItem(ItemType value) Sets the value of the item property.
void	setLineValidityPeriod(PeriodType value) Sets the value of the lineValidityPeriod property.
void	setNote(List<NoteType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setRequiredItemLocationQuantity(List<ItemLocationQuantityType> 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

CatalogueRequestLineType

public CatalogueRequestLineType()

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>Catalogue Request Line. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the requested catalogue line.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>1 </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

getContractSubdivision

@Nullable
public ContractSubdivisionType getContractSubdivision()

 <?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>Catalogue Request Line. Contract Subdivision. Text</ccts:DictionaryEntryName><ccts:Definition>A subdivision of a contract or tender covering the line being requested.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTerm>Contract Subdivision</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>Installation , Phase One , Support and Maintenance </ccts:Examples></ccts:Component>
 

Returns:

possible object is ContractSubdivisionType

setContractSubdivision

public void setContractSubdivision(@Nullable
                                   ContractSubdivisionType value)

Sets the value of the contractSubdivision property.

Parameters:

value - allowed object is ContractSubdivisionType

getNote

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<NoteType> getNote()

 <?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>Catalogue Request Line. Note. Text</ccts:DictionaryEntryName><ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTerm>Note</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getNote().add(newItem);
 

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

getLineValidityPeriod

@Nullable
public PeriodType getLineValidityPeriod()

 <?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>Catalogue Request Line. Line Validity_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period for which the information in the requested catalogue line is valid.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTermQualifier>Line Validity</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setLineValidityPeriod

public void setLineValidityPeriod(@Nullable
                                  PeriodType value)

Sets the value of the lineValidityPeriod property.

Parameters:

value - allowed object is PeriodType

getRequiredItemLocationQuantity

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ItemLocationQuantityType> getRequiredItemLocationQuantity()

 <?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>Catalogue Request Line. Required_ Item Location Quantity. Item Location Quantity</ccts:DictionaryEntryName><ccts:Definition>Properties of the item in the requested catalogue line that are dependent on location and quantity.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTermQualifier>Required</ccts:PropertyTermQualifier><ccts:PropertyTerm>Item Location Quantity</ccts:PropertyTerm><ccts:AssociatedObjectClass>Item Location Quantity</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Item Location Quantity</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getRequiredItemLocationQuantity().add(newItem);
 

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

getItem

@Nullable
public ItemType getItem()

 <?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>Catalogue Request Line. Item</ccts:DictionaryEntryName><ccts:Definition>The item associated with the requested catalogue line.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Catalogue Request Line</ccts:ObjectClass><ccts:PropertyTerm>Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Item</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is ItemType

setItem

public void setItem(@Nullable
                    ItemType value)

Sets the value of the item property.

Parameters:

value - allowed object is ItemType

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

setNote

public void setNote(@Nullable
                    List<NoteType> aList)

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

Parameters:

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

setRequiredItemLocationQuantity

public void setRequiredItemLocationQuantity(@Nullable
                                            List<ItemLocationQuantityType> aList)

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

Parameters:

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

hasNoteEntries

public boolean hasNoteEntries()

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

Returns:

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

hasNoNoteEntries

public boolean hasNoNoteEntries()

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

Returns:

true if no item is contained, false otherwise.

getNoteCount

@Nonnegative
public int getNoteCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getNoteAtIndex

@Nullable
public NoteType getNoteAtIndex(@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!

addNote

public void addNote(@Nonnull
                    NoteType elem)

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

Parameters:

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

hasRequiredItemLocationQuantityEntries

public boolean hasRequiredItemLocationQuantityEntries()

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

Returns:

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

hasNoRequiredItemLocationQuantityEntries

public boolean hasNoRequiredItemLocationQuantityEntries()

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

Returns:

true if no item is contained, false otherwise.

getRequiredItemLocationQuantityCount

@Nonnegative
public int getRequiredItemLocationQuantityCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getRequiredItemLocationQuantityAtIndex

@Nullable
public ItemLocationQuantityType getRequiredItemLocationQuantityAtIndex(@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!

addRequiredItemLocationQuantity

public void addRequiredItemLocationQuantity(@Nonnull
                                            ItemLocationQuantityType 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
                    CatalogueRequestLineType 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 CatalogueRequestLineType 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

setContractSubdivision

@Nonnull
public ContractSubdivisionType setContractSubdivision(@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 ContractSubdivisionType 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

getContractSubdivisionValue

@Nullable
public String getContractSubdivisionValue()

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

Returns:

Either the value of the contained ContractSubdivisionType object or null