oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class ForecastLineType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.ForecastLineType

public class ForecastLineType
extends Object

 <?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>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>
 

Java class for ForecastLineType complex type.

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

 <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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected PeriodType	forecastPeriod
protected ForecastTypeCodeType	forecastTypeCode
protected FrozenDocumentIndicatorType	frozenDocumentIndicator
protected IDType	id
protected List<NoteType>	note
protected SalesItemType	salesItem

Constructor Summary

Constructors

Constructor and Description
ForecastLineType()

Method Summary

Modifier and Type	Method and Description
PeriodType	getForecastPeriod() <?
ForecastTypeCodeType	getForecastTypeCode() <?
FrozenDocumentIndicatorType	getFrozenDocumentIndicator() <?
IDType	getID() <?
List<NoteType>	getNote() <?
SalesItemType	getSalesItem() <?
void	setForecastPeriod(PeriodType value) Sets the value of the forecastPeriod property.
void	setForecastTypeCode(ForecastTypeCodeType value) Sets the value of the forecastTypeCode property.
void	setFrozenDocumentIndicator(FrozenDocumentIndicatorType value) Sets the value of the frozenDocumentIndicator property.
void	setID(IDType value) Sets the value of the id property.
void	setSalesItem(SalesItemType value) Sets the value of the salesItem property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected IDType id

note

protected List<NoteType> note

frozenDocumentIndicator

protected FrozenDocumentIndicatorType frozenDocumentIndicator

forecastTypeCode

protected ForecastTypeCodeType forecastTypeCode

forecastPeriod

protected PeriodType forecastPeriod

salesItem

protected SalesItemType salesItem

Constructor Detail

ForecastLineType

public ForecastLineType()

Method Detail

getID

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>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>
 

Returns:

possible object is IDType

setID

public void setID(IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getNote

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>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>
 

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

getFrozenDocumentIndicator

public FrozenDocumentIndicatorType getFrozenDocumentIndicator()

 <?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>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>
 

Returns:

possible object is FrozenDocumentIndicatorType

setFrozenDocumentIndicator

public void setFrozenDocumentIndicator(FrozenDocumentIndicatorType value)

Sets the value of the frozenDocumentIndicator property.

Parameters:

value - allowed object is FrozenDocumentIndicatorType

getForecastTypeCode

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>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>
 

Returns:

possible object is ForecastTypeCodeType

setForecastTypeCode

public void setForecastTypeCode(ForecastTypeCodeType value)

Sets the value of the forecastTypeCode property.

Parameters:

value - allowed object is ForecastTypeCodeType

getForecastPeriod

public PeriodType getForecastPeriod()

 <?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>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>
 

Returns:

possible object is PeriodType

setForecastPeriod

public void setForecastPeriod(PeriodType value)

Sets the value of the forecastPeriod property.

Parameters:

value - allowed object is PeriodType

getSalesItem

public 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>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>
 

Returns:

possible object is SalesItemType

setSalesItem

public void setSalesItem(SalesItemType value)

Sets the value of the salesItem property.

Parameters:

value - allowed object is SalesItemType