ForecastLineType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.ForecastLineType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class ForecastLineType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Details</ccts:DictionaryEntryName><ccts:Definition>Detailed information about a particular Forecast Line within a Forecast Document</ccts:Definition><ccts:ObjectClass>Forecast Line</ccts:ObjectClass></ccts:Component> </pre> Java class for ForecastLineType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="ForecastLineType"> <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}Note" maxOccurs="unbounded" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}FrozenDocumentIndicator" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ForecastTypeCode"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ForecastPeriod" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SalesItem" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType> </pre> 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

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

Constructors
Constructor and Description
`ForecastLineType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNote(NoteType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`ForecastLineType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(ForecastLineType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`PeriodType`	`getForecastPeriod()` <pre> <?
`ForecastTypeCodeType`	`getForecastTypeCode()` <pre> <?
`String`	`getForecastTypeCodeValue()` Get the value of the contained ForecastTypeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`FrozenDocumentIndicatorType`	`getFrozenDocumentIndicator()` <pre> <?
`IDType`	`getID()` <pre> <?
`String`	`getIDValue()` Get the value of the contained IDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`List<NoteType>`	`getNote()` <pre> <?
`NoteType`	`getNoteAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getNoteCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`SalesItemType`	`getSalesItem()` <pre> <?
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoNoteEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoteEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`isFrozenDocumentIndicatorValue(boolean nullValue)` Get the value of the contained FrozenDocumentIndicatorType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setForecastPeriod(PeriodType value)` Sets the value of the forecastPeriod property.
`void`	`setForecastTypeCode(ForecastTypeCodeType value)` Sets the value of the forecastTypeCode property.
`ForecastTypeCodeType`	`setForecastTypeCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`FrozenDocumentIndicatorType`	`setFrozenDocumentIndicator(boolean valueParam)` Special setter with value of type boolean<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setFrozenDocumentIndicator(FrozenDocumentIndicatorType value)` Sets the value of the frozenDocumentIndicator property.
`void`	`setID(IDType value)` Sets the value of the id property.
`IDType`	`setID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setNote(List<NoteType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setSalesItem(SalesItemType value)` Sets the value of the salesItem 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
 - ForecastLineType
```
public ForecastLineType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getID
```
@Nullable
public IDType getID()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this forecast line.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Forecast Line</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component> </pre>
 
 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
 - getNote
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<NoteType> getNote()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast 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>Forecast Line</ccts:ObjectClass><ccts:PropertyTerm>Note</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component> </pre> 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 <CODE>set</CODE> method for the note property. For example, to add a new item, do as follows: <pre> getNote().add(newItem); </pre> Objects of the following type(s) are allowed in the list NoteType
 - getFrozenDocumentIndicator
```
@Nullable
public FrozenDocumentIndicatorType getFrozenDocumentIndicator()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Frozen Document Indicator. Indicator</ccts:DictionaryEntryName><ccts:Definition>An indicator that the status of the forecast is modifiable (true) or not (false).</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Forecast Line</ccts:ObjectClass><ccts:PropertyTerm>Frozen Document Indicator</ccts:PropertyTerm><ccts:RepresentationTerm>Indicator</ccts:RepresentationTerm><ccts:DataType>Indicator. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is FrozenDocumentIndicatorType
 - setFrozenDocumentIndicator
```
public void setFrozenDocumentIndicator(@Nullable
 FrozenDocumentIndicatorType value)
```
 Sets the value of the frozenDocumentIndicator property.
 
 Parameters:
 
 value - allowed object is FrozenDocumentIndicatorType
 - getForecastTypeCode
```
@Nullable
public ForecastTypeCodeType getForecastTypeCode()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Forecast Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of forecast. Examples: BASE PROMOTIONAL SEASONAL TOTAL</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Forecast Line</ccts:ObjectClass><ccts:PropertyTerm>Forecast Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>seasonal, total</ccts:Examples></ccts:Component> </pre>
 
 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
 - getForecastPeriod
```
@Nullable
public PeriodType getForecastPeriod()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Forecast_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period to which the forecast applies.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Forecast Line</ccts:ObjectClass><ccts:PropertyTermQualifier>Forecast</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PeriodType
 - setForecastPeriod
```
public void setForecastPeriod(@Nullable
 PeriodType value)
```
 Sets the value of the forecastPeriod property.
 
 Parameters:
 
 value - allowed object is PeriodType
 - getSalesItem
```
@Nullable
public SalesItemType getSalesItem()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Forecast Line. Sales Item</ccts:DictionaryEntryName><ccts:Definition>Sales information for the item to which this line applies.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Forecast Line</ccts:ObjectClass><ccts:PropertyTerm>Sales Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Sales Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Sales Item</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is SalesItemType
 - setSalesItem
```
public void setSalesItem(@Nullable
 SalesItemType value)
```
 Sets the value of the salesItem property.
 
 Parameters:
 
 value - allowed object is 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
 - 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 <code>null</code>.
 - hasNoteEntries
```
public boolean hasNoteEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoNoteEntries
```
public boolean hasNoNoteEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> 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 <code>null</code>
 
 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 <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 ForecastLineType ret)
```
 This method clones all values from <code>this</code> 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 <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public ForecastLineType 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 <code>null</code>.
 - 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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type ForecastTypeCodeType and never <code>null</code>
 - 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 <code>null</code>.
 
 Returns:
 
 The created intermediary object of type IDType and never <code>null</code>
 - setFrozenDocumentIndicator
```
@Nonnull
public FrozenDocumentIndicatorType setFrozenDocumentIndicator(boolean valueParam)
```
 Special setter with value of type boolean Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set.
 
 Returns:
 
 The created intermediary object of type FrozenDocumentIndicatorType and never <code>null</code>
 - 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 <code>null</code>
 - isFrozenDocumentIndicatorValue
```
public boolean isFrozenDocumentIndicatorValue(boolean nullValue)
```
 Get the value of the contained FrozenDocumentIndicatorType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 nullValue - The value to be returned, if the owning object is <code>null</code>
 
 Returns:
 
 Either the value of the contained FrozenDocumentIndicatorType object or the passed nullValue
 - 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 <code>null</code>

Class ForecastLineType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForecastLineType

Method Detail

getID

setID

getNote

getFrozenDocumentIndicator

setFrozenDocumentIndicator

getForecastTypeCode

setForecastTypeCode

getForecastPeriod

setForecastPeriod

getSalesItem

setSalesItem

equals

hashCode

toString

setNote

hasNoteEntries

hasNoNoteEntries

getNoteCount

getNoteAtIndex

addNote

cloneTo

clone

setForecastTypeCode

setID

setFrozenDocumentIndicator

getIDValue

isFrozenDocumentIndicatorValue

getForecastTypeCodeValue