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

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

Field Summary

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 NOTE: Plugin must never try to create any Reports objects itself.

Method Summary

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

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: Plugin must never try to create any Reports objects itself.

Throws:

PluginException

Method Detail

isUserParameter

public boolean isUserParameter()
                        throws PluginException

Throws:

PluginException

isSystemParameter

public boolean isSystemParameter()
                          throws PluginException

Returns true if this parameter is a system parameter, false otherwise.

Throws:

PluginException

getCurrentValue

public java.lang.String getCurrentValue()
                                 throws PluginException

Returns current value of this parameter

Throws:

PluginException

getInitialValue

public java.lang.String getInitialValue()
                                 throws PluginException

Returns initial value of this parameter

Throws:

PluginException