ForecastType (Difi Commons :: Universal Business Language (UBL) 2.1 0.9.5 API)

java.lang.Object
- no.difi.commons.ubl21.jaxb.ForecastType

public class ForecastType
extends Object

Java class for ForecastType complex type.

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

 <complexType name="ForecastType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2}UBLExtensions" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UBLVersionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CustomizationID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ProfileID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ProfileExecutionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CopyIndicator" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UUID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueDate"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueTime" 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:CommonBasicComponents-2}VersionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}BasedOnConsensusIndicator" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ForecastPurposeCode"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ForecastPeriod"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}AdditionalDocumentReference" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Signature" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SenderParty"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ReceiverParty"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}BuyerCustomerParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SellerSupplierParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ForecastLine" maxOccurs="unbounded"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<DocumentReferenceType>`	`additionalDocumentReference`
`protected BasedOnConsensusIndicatorType`	`basedOnConsensusIndicator`
`protected CustomerPartyType`	`buyerCustomerParty`
`protected CopyIndicatorType`	`copyIndicator`
`protected CustomizationIDType`	`customizationID`
`protected List<ForecastLineType>`	`forecastLine`
`protected PeriodType`	`forecastPeriod`
`protected ForecastPurposeCodeType`	`forecastPurposeCode`
`protected IDType`	`id`
`protected IssueDateType`	`issueDate`
`protected IssueTimeType`	`issueTime`
`protected List<NoteType>`	`note`
`protected ProfileExecutionIDType`	`profileExecutionID`
`protected ProfileIDType`	`profileID`
`protected PartyType`	`receiverParty`
`protected SupplierPartyType`	`sellerSupplierParty`
`protected PartyType`	`senderParty`
`protected List<SignatureType>`	`signature`
`protected UBLExtensionsType`	`ublExtensions`
`protected UBLVersionIDType`	`ublVersionID`
`protected UUIDType`	`uuid`
`protected VersionIDType`	`versionID`

Constructor Summary

Constructors
Constructor and Description

ForecastType()

Constructors
Constructor and Description
`ForecastType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DocumentReferenceType>`	`getAdditionalDocumentReference()` Gets the value of the additionalDocumentReference property.
`BasedOnConsensusIndicatorType`	`getBasedOnConsensusIndicator()` Gets the value of the basedOnConsensusIndicator property.
`CustomerPartyType`	`getBuyerCustomerParty()` Gets the value of the buyerCustomerParty property.
`CopyIndicatorType`	`getCopyIndicator()` Gets the value of the copyIndicator property.
`CustomizationIDType`	`getCustomizationID()` Gets the value of the customizationID property.
`List<ForecastLineType>`	`getForecastLine()` Gets the value of the forecastLine property.
`PeriodType`	`getForecastPeriod()` Gets the value of the forecastPeriod property.
`ForecastPurposeCodeType`	`getForecastPurposeCode()` Gets the value of the forecastPurposeCode property.
`IDType`	`getID()` Gets the value of the id property.
`IssueDateType`	`getIssueDate()` Gets the value of the issueDate property.
`IssueTimeType`	`getIssueTime()` Gets the value of the issueTime property.
`List<NoteType>`	`getNote()` Gets the value of the note property.
`ProfileExecutionIDType`	`getProfileExecutionID()` Gets the value of the profileExecutionID property.
`ProfileIDType`	`getProfileID()` Gets the value of the profileID property.
`PartyType`	`getReceiverParty()` Gets the value of the receiverParty property.
`SupplierPartyType`	`getSellerSupplierParty()` Gets the value of the sellerSupplierParty property.
`PartyType`	`getSenderParty()` Gets the value of the senderParty property.
`List<SignatureType>`	`getSignature()` Gets the value of the signature property.
`UBLExtensionsType`	`getUBLExtensions()` Gets the value of the ublExtensions property.
`UBLVersionIDType`	`getUBLVersionID()` Gets the value of the ublVersionID property.
`UUIDType`	`getUUID()` Gets the value of the uuid property.
`VersionIDType`	`getVersionID()` Gets the value of the versionID property.
`void`	`setBasedOnConsensusIndicator(BasedOnConsensusIndicatorType value)` Sets the value of the basedOnConsensusIndicator property.
`void`	`setBuyerCustomerParty(CustomerPartyType value)` Sets the value of the buyerCustomerParty property.
`void`	`setCopyIndicator(CopyIndicatorType value)` Sets the value of the copyIndicator property.
`void`	`setCustomizationID(CustomizationIDType value)` Sets the value of the customizationID property.
`void`	`setForecastPeriod(PeriodType value)` Sets the value of the forecastPeriod property.
`void`	`setForecastPurposeCode(ForecastPurposeCodeType value)` Sets the value of the forecastPurposeCode property.
`void`	`setID(IDType value)` Sets the value of the id property.
`void`	`setIssueDate(IssueDateType value)` Sets the value of the issueDate property.
`void`	`setIssueTime(IssueTimeType value)` Sets the value of the issueTime property.
`void`	`setProfileExecutionID(ProfileExecutionIDType value)` Sets the value of the profileExecutionID property.
`void`	`setProfileID(ProfileIDType value)` Sets the value of the profileID property.
`void`	`setReceiverParty(PartyType value)` Sets the value of the receiverParty property.
`void`	`setSellerSupplierParty(SupplierPartyType value)` Sets the value of the sellerSupplierParty property.
`void`	`setSenderParty(PartyType value)` Sets the value of the senderParty property.
`void`	`setUBLExtensions(UBLExtensionsType value)` Sets the value of the ublExtensions property.
`void`	`setUBLVersionID(UBLVersionIDType value)` Sets the value of the ublVersionID property.
`void`	`setUUID(UUIDType value)` Sets the value of the uuid property.
`void`	`setVersionID(VersionIDType value)` Sets the value of the versionID property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ublExtensions
```
protected UBLExtensionsType ublExtensions
```
  - ublVersionID
```
protected UBLVersionIDType ublVersionID
```
  - customizationID
```
protected CustomizationIDType customizationID
```
  - profileID
```
protected ProfileIDType profileID
```
  - profileExecutionID
```
protected ProfileExecutionIDType profileExecutionID
```
  - id
```
protected IDType id
```
  - copyIndicator
```
protected CopyIndicatorType copyIndicator
```
  - uuid
```
protected UUIDType uuid
```
  - issueDate
```
protected IssueDateType issueDate
```
  - issueTime
```
protected IssueTimeType issueTime
```
  - note
```
protected List<NoteType> note
```
  - versionID
```
protected VersionIDType versionID
```
  - basedOnConsensusIndicator
```
protected BasedOnConsensusIndicatorType basedOnConsensusIndicator
```
  - forecastPurposeCode
```
protected ForecastPurposeCodeType forecastPurposeCode
```
  - forecastPeriod
```
protected PeriodType forecastPeriod
```
  - additionalDocumentReference
```
protected List<DocumentReferenceType> additionalDocumentReference
```
  - signature
```
protected List<SignatureType> signature
```
  - senderParty
```
protected PartyType senderParty
```
  - receiverParty
```
protected PartyType receiverParty
```
  - buyerCustomerParty
```
protected CustomerPartyType buyerCustomerParty
```
  - sellerSupplierParty
```
protected SupplierPartyType sellerSupplierParty
```
  - forecastLine
```
protected List<ForecastLineType> forecastLine
```
- Constructor Detail
  - ForecastType
```
public ForecastType()
```
- Method Detail
  - getUBLExtensions
```
public UBLExtensionsType getUBLExtensions()
```
    Gets the value of the ublExtensions property.
    
    Returns:
    
    possible object is UBLExtensionsType
  - setUBLExtensions
```
public void setUBLExtensions(UBLExtensionsType value)
```
    Sets the value of the ublExtensions property.
    
    Parameters:
    
    value - allowed object is UBLExtensionsType
  - getUBLVersionID
```
public UBLVersionIDType getUBLVersionID()
```
    Gets the value of the ublVersionID property.
    
    Returns:
    
    possible object is UBLVersionIDType
  - setUBLVersionID
```
public void setUBLVersionID(UBLVersionIDType value)
```
    Sets the value of the ublVersionID property.
    
    Parameters:
    
    value - allowed object is UBLVersionIDType
  - getCustomizationID
```
public CustomizationIDType getCustomizationID()
```
    Gets the value of the customizationID property.
    
    Returns:
    
    possible object is CustomizationIDType
  - setCustomizationID
```
public void setCustomizationID(CustomizationIDType value)
```
    Sets the value of the customizationID property.
    
    Parameters:
    
    value - allowed object is CustomizationIDType
  - getProfileID
```
public ProfileIDType getProfileID()
```
    Gets the value of the profileID property.
    
    Returns:
    
    possible object is ProfileIDType
  - setProfileID
```
public void setProfileID(ProfileIDType value)
```
    Sets the value of the profileID property.
    
    Parameters:
    
    value - allowed object is ProfileIDType
  - getProfileExecutionID
```
public ProfileExecutionIDType getProfileExecutionID()
```
    Gets the value of the profileExecutionID property.
    
    Returns:
    
    possible object is ProfileExecutionIDType
  - setProfileExecutionID
```
public void setProfileExecutionID(ProfileExecutionIDType value)
```
    Sets the value of the profileExecutionID property.
    
    Parameters:
    
    value - allowed object is ProfileExecutionIDType
  - getID
```
public IDType getID()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is IDType
  - setID
```
public void setID(IDType value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is IDType
  - getCopyIndicator
```
public CopyIndicatorType getCopyIndicator()
```
    Gets the value of the copyIndicator property.
    
    Returns:
    
    possible object is CopyIndicatorType
  - setCopyIndicator
```
public void setCopyIndicator(CopyIndicatorType value)
```
    Sets the value of the copyIndicator property.
    
    Parameters:
    
    value - allowed object is CopyIndicatorType
  - getUUID
```
public UUIDType getUUID()
```
    Gets the value of the uuid property.
    
    Returns:
    
    possible object is UUIDType
  - setUUID
```
public void setUUID(UUIDType value)
```
    Sets the value of the uuid property.
    
    Parameters:
    
    value - allowed object is UUIDType
  - getIssueDate
```
public IssueDateType getIssueDate()
```
    Gets the value of the issueDate property.
    
    Returns:
    
    possible object is IssueDateType
  - setIssueDate
```
public void setIssueDate(IssueDateType value)
```
    Sets the value of the issueDate property.
    
    Parameters:
    
    value - allowed object is IssueDateType
  - getIssueTime
```
public IssueTimeType getIssueTime()
```
    Gets the value of the issueTime property.
    
    Returns:
    
    possible object is IssueTimeType
  - setIssueTime
```
public void setIssueTime(IssueTimeType value)
```
    Sets the value of the issueTime property.
    
    Parameters:
    
    value - allowed object is IssueTimeType
  - getNote
```
public List<NoteType> getNote()
```
    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
  - getVersionID
```
public VersionIDType getVersionID()
```
    Gets the value of the versionID property.
    
    Returns:
    
    possible object is VersionIDType
  - setVersionID
```
public void setVersionID(VersionIDType value)
```
    Sets the value of the versionID property.
    
    Parameters:
    
    value - allowed object is VersionIDType
  - getBasedOnConsensusIndicator
```
public BasedOnConsensusIndicatorType getBasedOnConsensusIndicator()
```
    Gets the value of the basedOnConsensusIndicator property.
    
    Returns:
    
    possible object is BasedOnConsensusIndicatorType
  - setBasedOnConsensusIndicator
```
public void setBasedOnConsensusIndicator(BasedOnConsensusIndicatorType value)
```
    Sets the value of the basedOnConsensusIndicator property.
    
    Parameters:
    
    value - allowed object is BasedOnConsensusIndicatorType
  - getForecastPurposeCode
```
public ForecastPurposeCodeType getForecastPurposeCode()
```
    Gets the value of the forecastPurposeCode property.
    
    Returns:
    
    possible object is ForecastPurposeCodeType
  - setForecastPurposeCode
```
public void setForecastPurposeCode(ForecastPurposeCodeType value)
```
    Sets the value of the forecastPurposeCode property.
    
    Parameters:
    
    value - allowed object is ForecastPurposeCodeType
  - getForecastPeriod
```
public PeriodType getForecastPeriod()
```
    Gets the value of the forecastPeriod property.
    
    Returns:
    
    possible object is PeriodType
  - setForecastPeriod
```
public void setForecastPeriod(PeriodType value)
```
    Sets the value of the forecastPeriod property.
    
    Parameters:
    
    value - allowed object is PeriodType
  - getAdditionalDocumentReference
```
public List<DocumentReferenceType> getAdditionalDocumentReference()
```
    Gets the value of the additionalDocumentReference 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 additionalDocumentReference property.
    For example, to add a new item, do as follows:
```
    getAdditionalDocumentReference().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DocumentReferenceType
  - getSignature
```
public List<SignatureType> getSignature()
```
    Gets the value of the signature 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 signature property.
    For example, to add a new item, do as follows:
```
    getSignature().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SignatureType
  - getSenderParty
```
public PartyType getSenderParty()
```
    Gets the value of the senderParty property.
    
    Returns:
    
    possible object is PartyType
  - setSenderParty
```
public void setSenderParty(PartyType value)
```
    Sets the value of the senderParty property.
    
    Parameters:
    
    value - allowed object is PartyType
  - getReceiverParty
```
public PartyType getReceiverParty()
```
    Gets the value of the receiverParty property.
    
    Returns:
    
    possible object is PartyType
  - setReceiverParty
```
public void setReceiverParty(PartyType value)
```
    Sets the value of the receiverParty property.
    
    Parameters:
    
    value - allowed object is PartyType
  - getBuyerCustomerParty
```
public CustomerPartyType getBuyerCustomerParty()
```
    Gets the value of the buyerCustomerParty property.
    
    Returns:
    
    possible object is CustomerPartyType
  - setBuyerCustomerParty
```
public void setBuyerCustomerParty(CustomerPartyType value)
```
    Sets the value of the buyerCustomerParty property.
    
    Parameters:
    
    value - allowed object is CustomerPartyType
  - getSellerSupplierParty
```
public SupplierPartyType getSellerSupplierParty()
```
    Gets the value of the sellerSupplierParty property.
    
    Returns:
    
    possible object is SupplierPartyType
  - setSellerSupplierParty
```
public void setSellerSupplierParty(SupplierPartyType value)
```
    Sets the value of the sellerSupplierParty property.
    
    Parameters:
    
    value - allowed object is SupplierPartyType
  - getForecastLine
```
public List<ForecastLineType> getForecastLine()
```
    Gets the value of the forecastLine 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 forecastLine property.
    For example, to add a new item, do as follows:
```
    getForecastLine().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ForecastLineType

Class ForecastType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ublExtensions

ublVersionID

customizationID

profileID

profileExecutionID

id

copyIndicator

uuid

issueDate

issueTime

note

versionID

basedOnConsensusIndicator

forecastPurposeCode

forecastPeriod

additionalDocumentReference

signature

senderParty

receiverParty

buyerCustomerParty

sellerSupplierParty

forecastLine

Constructor Detail

ForecastType

Method Detail

getUBLExtensions

setUBLExtensions

getUBLVersionID

setUBLVersionID

getCustomizationID

setCustomizationID

getProfileID

setProfileID

getProfileExecutionID

setProfileExecutionID

getID

setID

getCopyIndicator

setCopyIndicator

getUUID

setUUID

getIssueDate

setIssueDate

getIssueTime

setIssueTime

getNote

getVersionID

setVersionID

getBasedOnConsensusIndicator

setBasedOnConsensusIndicator

getForecastPurposeCode

setForecastPurposeCode

getForecastPeriod

setForecastPeriod

getAdditionalDocumentReference

getSignature

getSenderParty

setSenderParty

getReceiverParty

setReceiverParty

getBuyerCustomerParty

setBuyerCustomerParty

getSellerSupplierParty

setSellerSupplierParty

getForecastLine