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

Class ItemInformationRequestLineType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ItemInformationRequestLineType
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 Information Request Line. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a line in an Item Information Request asking a trading partner for item information.</ccts:Definition><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass></ccts:Component>
 

Java class for ItemInformationRequestLineType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addPeriod(PeriodType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addSalesItem(SalesItemType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ItemInformationRequestLineType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ItemInformationRequestLineType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
ForecastTypeCodeType	getForecastTypeCode() <?
String	getForecastTypeCodeValue() Get the value of the contained ForecastTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PerformanceMetricTypeCodeType	getPerformanceMetricTypeCode() <?
String	getPerformanceMetricTypeCodeValue() Get the value of the contained PerformanceMetricTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<PeriodType>	getPeriod() <?
PeriodType	getPeriodAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getPeriodCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<SalesItemType>	getSalesItem() <?
SalesItemType	getSalesItemAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getSalesItemCount() Created by ph-jaxb22-plugin -Xph-list-extension
SupplyChainActivityTypeCodeType	getSupplyChainActivityTypeCode() <?
String	getSupplyChainActivityTypeCodeValue() Get the value of the contained SupplyChainActivityTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
TimeFrequencyCodeType	getTimeFrequencyCode() <?
String	getTimeFrequencyCodeValue() Get the value of the contained TimeFrequencyCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoPeriodEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoSalesItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasPeriodEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasSalesItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setForecastTypeCode(ForecastTypeCodeType value) Sets the value of the forecastTypeCode property.
ForecastTypeCodeType	setForecastTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setPerformanceMetricTypeCode(PerformanceMetricTypeCodeType value) Sets the value of the performanceMetricTypeCode property.
PerformanceMetricTypeCodeType	setPerformanceMetricTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setPeriod(List<PeriodType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setSalesItem(List<SalesItemType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
SupplyChainActivityTypeCodeType	setSupplyChainActivityTypeCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setSupplyChainActivityTypeCode(SupplyChainActivityTypeCodeType value) Sets the value of the supplyChainActivityTypeCode property.
TimeFrequencyCodeType	setTimeFrequencyCode(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setTimeFrequencyCode(TimeFrequencyCodeType value) Sets the value of the timeFrequencyCode 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

ItemInformationRequestLineType

public ItemInformationRequestLineType()

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

Method Detail

getTimeFrequencyCode

@Nullable
public TimeFrequencyCodeType getTimeFrequencyCode()

 <?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 Information Request Line. Time Frequency Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the frequency with which item information should be sent to the requester.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Time Frequency Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is TimeFrequencyCodeType

setTimeFrequencyCode

public void setTimeFrequencyCode(@Nullable
                                 TimeFrequencyCodeType value)

Sets the value of the timeFrequencyCode property.

Parameters:

value - allowed object is TimeFrequencyCodeType

getSupplyChainActivityTypeCode

@Nullable
public SupplyChainActivityTypeCodeType getSupplyChainActivityTypeCode()

 <?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 Information Request Line. Supply Chain Activity Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code used to identify the type of supply chain activity about which information request is issued. Examples: CANCELED_ORDERS EMERGENCY_ORDERS ON_HAND ORDERS</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Supply Chain Activity Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is SupplyChainActivityTypeCodeType

setSupplyChainActivityTypeCode

public void setSupplyChainActivityTypeCode(@Nullable
                                           SupplyChainActivityTypeCodeType value)

Sets the value of the supplyChainActivityTypeCode property.

Parameters:

value - allowed object is SupplyChainActivityTypeCodeType

getForecastTypeCode

@Nullable
public ForecastTypeCodeType getForecastTypeCode()

 <?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 Information Request Line. Forecast Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>The information request can be either about supply chain activity or about forecasts or about performance metrics, so it should be optional</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Forecast Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ForecastTypeCodeType

setForecastTypeCode

public void setForecastTypeCode(@Nullable
                                ForecastTypeCodeType value)

Sets the value of the forecastTypeCode property.

Parameters:

value - allowed object is ForecastTypeCodeType

getPerformanceMetricTypeCode

@Nullable
public PerformanceMetricTypeCodeType getPerformanceMetricTypeCode()

 <?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 Information Request Line. Performance Metric Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying a measure of performance.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Performance Metric Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is PerformanceMetricTypeCodeType

setPerformanceMetricTypeCode

public void setPerformanceMetricTypeCode(@Nullable
                                         PerformanceMetricTypeCodeType value)

Sets the value of the performanceMetricTypeCode property.

Parameters:

value - allowed object is PerformanceMetricTypeCodeType

getPeriod

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PeriodType> getPeriod()

 <?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 Information Request Line. Period</ccts:DictionaryEntryName><ccts:Definition>A period for which this information is requested.</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getPeriod().add(newItem);
 

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

getSalesItem

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<SalesItemType> getSalesItem()

 <?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 Information Request Line. Sales Item</ccts:DictionaryEntryName><ccts:Definition>Sales information for the item to which this line applies.</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>Item Information Request Line</ccts:ObjectClass><ccts:PropertyTerm>Sales Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Sales Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Sales Item</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getSalesItem().add(newItem);
 

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

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

setPeriod

public void setPeriod(@Nullable
                      List<PeriodType> aList)

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

Parameters:

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

setSalesItem

public void setSalesItem(@Nullable
                         List<SalesItemType> aList)

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

Parameters:

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

hasPeriodEntries

public boolean hasPeriodEntries()

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

Returns:

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

hasNoPeriodEntries

public boolean hasNoPeriodEntries()

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

Returns:

true if no item is contained, false otherwise.

getPeriodCount

@Nonnegative
public int getPeriodCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getPeriodAtIndex

@Nullable
public PeriodType getPeriodAtIndex(@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!

addPeriod

public void addPeriod(@Nonnull
                      PeriodType elem)

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

Parameters:

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

hasSalesItemEntries

public boolean hasSalesItemEntries()

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

Returns:

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

hasNoSalesItemEntries

public boolean hasNoSalesItemEntries()

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

Returns:

true if no item is contained, false otherwise.

getSalesItemCount

@Nonnegative
public int getSalesItemCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getSalesItemAtIndex

@Nullable
public SalesItemType getSalesItemAtIndex(@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!

addSalesItem

public void addSalesItem(@Nonnull
                         SalesItemType 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
                    ItemInformationRequestLineType 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 ItemInformationRequestLineType 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.

setTimeFrequencyCode

@Nonnull
public TimeFrequencyCodeType setTimeFrequencyCode(@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 TimeFrequencyCodeType and never null

setSupplyChainActivityTypeCode

@Nonnull
public SupplyChainActivityTypeCodeType setSupplyChainActivityTypeCode(@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 SupplyChainActivityTypeCodeType and never null

setForecastTypeCode

@Nonnull
public ForecastTypeCodeType setForecastTypeCode(@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 ForecastTypeCodeType and never null

setPerformanceMetricTypeCode

@Nonnull
public PerformanceMetricTypeCodeType setPerformanceMetricTypeCode(@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 PerformanceMetricTypeCodeType and never null

getTimeFrequencyCodeValue

@Nullable
public String getTimeFrequencyCodeValue()

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

Returns:

Either the value of the contained TimeFrequencyCodeType object or null

getSupplyChainActivityTypeCodeValue

@Nullable
public String getSupplyChainActivityTypeCodeValue()

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

Returns:

Either the value of the contained SupplyChainActivityTypeCodeType object or null

getForecastTypeCodeValue

@Nullable
public String getForecastTypeCodeValue()

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

Returns:

Either the value of the contained ForecastTypeCodeType object or null

getPerformanceMetricTypeCodeValue

@Nullable
public String getPerformanceMetricTypeCodeValue()

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

Returns:

Either the value of the contained PerformanceMetricTypeCodeType object or null