Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2.0.3)

B14351-03 Beta Draft

oracle.AWXML
Class ForecastArgument

java.lang.Object
  extended by oracle.AWXML.BaseObject
      extended by oracle.AWXML.ForecastArgument

public class ForecastArgument
extends BaseObject

An argument to a ForecastDefinition. A ForecastArgument contains a ForeCastKeyWord and a ForecastArgumentValue. The ForeCastKeyWord specifies a keyword that identifies the argument. The ForecastArgumentValue specifies a value that affects the argument.

For a list of the ForeCastKeyWord keyword values and their associated ForecastArgumentValue values, and descriptions of them, see Forecast Argument Keywords and Values.

You create ForecastArgument with the ForecastDefinition.createForecastArgument() method. You then create ForeCastKeyWord with the ForecastArgument.setForecastKeyWord(String input) method. You create a ForecastArgumentValue with a ForecastArgumentValue constructor and then associate it with a ForecastArgument by calling the ForecastArgument.setForecastArgumentValue.

See Also:
ForecastDefinition

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
ForecastArgument(BaseObject input)
          Creates a ForecastArgument for the specified ForecastDefinition.
 
Method Summary
 ForecastArgumentValue getForecastArgumentValue()
          Gets the ForecastArgumentValue for the ForecastArgument.
 ForeCastKeyWord getForecastKeyWord()
          Gets the ForeCastKeyWord associated with the ForecastArgument.
 void setForecastArgumentValue(ForecastArgumentValue input)
          Specifies the ForecastArgumentValue for the ForecastArgument.
 void setForecastKeyWord(ForeCastKeyWord input)
          Specifies the ForeCastKeyWord for the ForecastArgument.
 void setForecastKeyWord(java.lang.String input)
          Creates a ForeCastKeyWord and specifies it as the ForeCastKeyWord for this ForecastArgument.
 java.lang.String WriteToXML()
          Gets an XML representation of the ForecastArgument.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ForecastArgument

public ForecastArgument(BaseObject input)
Creates a ForecastArgument for the specified ForecastDefinition. An application should create a ForecastArgument with the createForecastArgument method of a ForecastDefinition.

Parameters:
input - The ForecastDefinition to own the new ForecastArgument.
Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the ForecastArgument.

Overrides:
WriteToXML in class BaseObject
Returns:
An XML String that represents the ForecastArgument.

getForecastKeyWord

public ForeCastKeyWord getForecastKeyWord()
Gets the ForeCastKeyWord associated with the ForecastArgument.

Returns:
The ForeCastKeyWord for the ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(ForeCastKeyWord input)
Specifies the ForeCastKeyWord for the ForecastArgument.

Parameters:
input - The ForeCastKeyWord for the ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(java.lang.String input)
Creates a ForeCastKeyWord and specifies it as the ForeCastKeyWord for this ForecastArgument. For a table of forecast argument keywords and associated argument values, see Forecast Argument Keywords and Values. The Keyword column of the table lists the valid values for the input parameter of this method.

Parameters:
input - A String that specifies the forecast argument keyword.

setForecastArgumentValue

public void setForecastArgumentValue(ForecastArgumentValue input)
Specifies the ForecastArgumentValue for the ForecastArgument.

Parameters:
input - The ForecastArgumentValue for the ForecastArgument.

getForecastArgumentValue

public ForecastArgumentValue getForecastArgumentValue()
Gets the ForecastArgumentValue for the ForecastArgument.

Returns:
The ForecastArgumentValue for the ForecastArgument.

Copyright © 2003, 2006 Oracle. All rights reserved.