oracle.reports.plugin.definition
Class Parameter

java.lang.Object
  |
  +--oracle.reports.plugin.definition.BaseObject
        |
        +--oracle.reports.plugin.definition.Column
              |
              +--oracle.reports.plugin.definition.Parameter

public class Parameter

extends Column

The Reports parameter object. Note: Reports does not allow a plugin to create any Reports objects by itself. If a plugin needs a new user parameter, it can return a non-existing column name from the getReferencedColumns method, and Reports will create a new user parameter of that name. See getReferencedColumns for details.

Fields inherited from class oracle.reports.plugin.definition.Column

DATATYPE_BFILE, DATATYPE_BLOB, DATATYPE_CHAR, DATATYPE_CLOB, DATATYPE_COLLECTION, DATATYPE_DATE, DATATYPE_GRAPHIC, DATATYPE_LONG, DATATYPE_LONG_RAW, DATATYPE_MLABLE, DATATYPE_NAMED_TYPE, DATATYPE_NCLOB, DATATYPE_NUMBER, DATATYPE_RAW, DATATYPE_REF, DATATYPE_ROWID, DATATYPE_UNKNOWN, DATATYPE_VARCHAR, DATATYPE_VARCHAR2, mRWObj

Fields inherited from class oracle.reports.plugin.definition.BaseObject

mReport

Constructor Summary

Parameter(oracle.reports.definition.RWDataItem rwobj, Report report)
Constructor.

Method Summary

java.lang.String	getCurrentValue() Returns the current value of this parameter.
java.lang.String	getInitialValue() Returns the initial value of this parameter.
boolean	isSystemParameter() Returns true if this parameter is a system parameter; false if not.
boolean	isUserParameter() Returns true if this parameter is a user parameter; false if not.

Methods inherited from class oracle.reports.plugin.definition.Column

createColumn, getDataType, getGroup

Methods inherited from class oracle.reports.plugin.definition.BaseObject

getComment, getName, getReport

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(oracle.reports.definition.RWDataItem rwobj,
Report report)
          throws PluginException

Constructor. NOTE: A plugin must never try to create any Reports objects itself.

Method Detail

isUserParameter

public boolean isUserParameter()
                        throws PluginException

Returns true if this parameter is a user parameter; false if not.

isSystemParameter

public boolean isSystemParameter()
                          throws PluginException

Returns true if this parameter is a system parameter; false if not.

getCurrentValue

public java.lang.String getCurrentValue()
                                 throws PluginException

Returns the current value of this parameter.

getInitialValue

public java.lang.String getInitialValue()
                                 throws PluginException

Returns the initial value of this parameter.