Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Oracle Reports
Java API Reference
10
g
(9.0.4)
B12019-01
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
A
B
C
D
E
F
G
H
I
J
L
M
N
O
P
R
S
T
U
W
G
getAdditionalFiles(ShortArrayHolder, LongLongArrayHolder, boolean)
- Method in interface oracle.reports.cache.
CacheItem
Returns additional file names and formats.
getAllColumns()
- Method in class oracle.reports.plugin.definition.
Report
Returns all columns in this report.
getArray(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getArray(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getAsciiStream(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getAsciiStream(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBigDecimal(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the BigDecimal value.
getBigDecimal(int, int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBigDecimal(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBigDecimal(String, int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBinaryStream(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBinaryStream(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBindValue()
- Method in class oracle.reports.plugin.
PluginCondition
Returns the bind value of the condition.
getBlob(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBlob(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBoolean(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Boolean value.
getBoolean(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getByte(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getByte(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBytes(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getBytes(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getCacheDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the cache directory.
getCacheItem()
- Method in class oracle.reports.server.
Destination
Returns the cache item associated with the destination.
getCacheItems()
- Method in interface oracle.reports.server.
Job
Returns the cache items for the job.
getCatalogName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Not used by the Reports Plugin API; simply stub it.
getCharacterStream(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getCharacterStream(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getClob(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getClob(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getColumn()
- Method in class oracle.reports.plugin.
PluginCondition
Returns the index of the column to which the condition applies.
getColumnClassName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Not used by the Reports Plugin API; simply stub it.
getColumnCount()
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the number of columns.
getColumnDisplaySize(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the display size.
getColumnLabel(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the column label.
getColumnName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the name of the specific column in the row.
getColumns()
- Method in class oracle.reports.plugin.definition.
Group
Returns the columns in this group.
getColumnType(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the column data type.
getColumnTypeName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Not used by the Reports Plugin API; simply stub it.
getCommandLine()
- Method in interface oracle.reports.server.
Job
Get the command line.
getCommandLineArguments()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the command line arguments.
getComment()
- Method in class oracle.reports.plugin.definition.
BaseObject
Returns the comment of the object.
getConcurrency()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getConfigDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the configuration directory.
getContent(String)
- Method in class oracle.reports.server.
Destination
Returns the contents of a file from the cache.
getContent(String)
- Method in interface oracle.reports.cache.
CacheItem
Returns file content from the cache.
getCurrentCapacity()
- Method in interface oracle.reports.cache.
Cache
Returns the current cache capacity in bytes.
getCurrentNumberOfFiles()
- Method in interface oracle.reports.cache.
Cache
Returns the current number of files in the cache.
getCurrentRow()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the current row.
getCurrentValue()
- Method in class oracle.reports.plugin.definition.
Parameter
Returns the current value of this parameter.
getCursorName()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getDataSource()
- Method in class oracle.reports.plugin.definition.
Group
Returns the data source of this group.
getDataSource()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the hosting Reports data source object of the plugin.
getDataSources()
- Method in class oracle.reports.plugin.definition.
Report
Returns the data sources in this report.
getDataType()
- Method in class oracle.reports.plugin.definition.
Column
Returns the data type of this column.
getDate(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Date value.
getDate(int, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getDate(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getDate(String, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getDefaultSignOnParameter()
- Method in interface oracle.reports.plugin.datasource.
PluginDataSourceFactory
Returns the name of the default Sign-on Parameter of this type of Plugin Data Source.
getDefaultSignOnParameter()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceFactoryTemplate
The Template Data Source does not support the Sign-on Parameter.
getDesname()
- Method in class oracle.reports.server.
Destination
Returns the destination name (DESNAME) of the object.
getDestype()
- Method in class oracle.reports.server.
Destination
Returns the destination type (DESTYPE) of the object.
getDouble(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Double value.
getDouble(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getDTDDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the DTD directory.
getDuplicatedJob()
- Method in interface oracle.reports.server.
Job
Returns the duplicated job.
getEditor()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the plugin's editor.
getEditor()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the plugin's editor.
getEditorClass()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the plugin editor's class name.
getErrorCode()
- Method in class oracle.reports.plugin.
PluginException
Returns the error code of the exception.
getExpiration()
- Method in interface oracle.reports.cache.
CacheItem
Returns the expiration time for the CacheItem.
getFactory()
- Method in interface oracle.reports.plugin.
Plugin
Returns the factory object that creates the plugin.
getFactory()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the factory passed to setFactory.
getFetchDirection()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getFetchSize()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getFinishedTime()
- Method in interface oracle.reports.cache.
CacheItem
Returns the completed time of the CacheItem.
getFirstChild()
- Method in class oracle.reports.plugin.definition.
Group
Returns the first child group of this group.
getFirstGroup()
- Method in class oracle.reports.plugin.definition.
Report
Returns the first group in this report.
getFloat(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Float value.
getFloat(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getGroup()
- Method in class oracle.reports.plugin.definition.
Column
Returns the group of this column.
getGroups()
- Method in class oracle.reports.plugin.definition.
DataSource
Returns the groups of this data source.
getHelpPrefix()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the prefix string for the error message help (e.g., "XR" for Express).
getHelpPrefix()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the prefix string for the error message help (e.g., "XR" for Express).
getHelpSet()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the full path of the helpset file or a URL to the helpset file.
getHelpSet()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the full path of the helpset file or a URL to the helpset file.
getHint()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the hint message of this type of plugin.
getHint()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the plugin class name.
getIconName()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the icon name of the plugin.
getIconName()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the icon name of the plugin.
getIgnoreParams()
- Method in interface oracle.reports.cache.
Cache
Get parameter names that will be ignored when calculating the cache item key
getInitialValue()
- Method in class oracle.reports.plugin.definition.
Parameter
Returns the initial value of this parameter.
getInt(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Int value.
getInt(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getJob()
- Method in class oracle.reports.server.
Destination
Returns the job object to which the destination object attaches.
getJob()
- Method in interface oracle.reports.cache.
CacheItem
Returns the job owning this CacheItem.
getJobInfo()
- Method in interface oracle.reports.server.
Job
Returns the job info.
getKey()
- Method in interface oracle.reports.engine.
EngineInterface
Returns the engine key that is used while accessing the engine object.
getKey()
- Method in interface oracle.reports.cache.
CacheItem
Returns the Item Key.
getLocale()
- Method in class oracle.reports.plugin.definition.
ReportContext
getLong(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Long value.
getLong(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getMainFile(ShortHolder, LongHolder, boolean)
- Method in interface oracle.reports.cache.
CacheItem
Returns the main file name and format.
getMajorVersion()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the major version of the plugin.
getMajorVersion()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the major version of the plugin.
getMaxCapacity()
- Method in interface oracle.reports.cache.
Cache
Returns the maximum cache capacity value in megabytes (MB).
getMaxNumberOfFiles()
- Method in interface oracle.reports.cache.
Cache
Returns the maximum number of files.
getMetaData()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns meta-data of the Result Set.
getMinorVersion()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the minor version of the plugin.
getMinorVersion()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the minor version of the plugin.
getModule()
- Method in class oracle.reports.plugin.
PluginException
Returns the name of the module that raised the exception.
getName()
- Method in interface oracle.reports.server.
Security
Returns the name of the security system.
getName()
- Method in interface oracle.reports.plugin.
PluginFactory
Returns the name of this type of plugin.
getName()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the plugin name.
getName()
- Method in class oracle.reports.plugin.definition.
BaseObject
Returns the name of the object.
getNextSibling()
- Method in class oracle.reports.plugin.definition.
Group
Returns the next sibling group of this group.
getObject(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the object value.
getObject(int, Map)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getObject(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getObject(String, Map)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getOperator()
- Method in class oracle.reports.plugin.
PluginCondition
Returns the operator of the condition.
getOracleHome()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the ORACLE_HOME directory.
getParameters()
- Method in interface oracle.reports.server.
Job
Returns all parameters.
getParent()
- Method in class oracle.reports.plugin.definition.
Group
Returns the parent group of this group.
getPluginClass()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the plugin's class name.
getPluginParam(String)
- Method in class oracle.reports.server.
Destination
Returns the plugin parameter value given the parameter name.
getPluginParam(String)
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the named plugin parameter from the server configuration file.
getPrecision(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the precision of the column.
getPreviousSibling()
- Method in class oracle.reports.plugin.definition.
Group
Returns the previous sibling group of this group.
getProperties()
- Method in class oracle.reports.server.
Destination
Returns the properties for the destination.
getQueryDescription()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the highlight data source description to be displayed in the Reports Wizard Data page.
getQueryDescription()
- Method in interface oracle.reports.plugin.datasource.
PluginDataSource
Returns the text description of the query, which usually contains the information of the source, columns, and bind variables.
getRef(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getRef(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getReferencedColumns()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
The Template Plugin Data Source does not reference Reports columns.
getReferencedColumns()
- Method in interface oracle.reports.plugin.datasource.
PluginDataSource
Returns the names of the Reports columns whose values will be used in the Plugin Data Source's execution.
getReport()
- Method in class oracle.reports.plugin.definition.
BaseObject
Returns the report of the object.
getReport()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the hosting report of the plugin.
getReportContext()
- Method in class oracle.reports.plugin.
PluginFactoryTemplate
Returns the Report Context, which is passed in to setReportContext.
getReportContext()
- Method in class oracle.reports.plugin.definition.
Report
Returns the context object of the report.
getReportContext()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the report context, which provides environment information.
getReportLevelColumns()
- Method in class oracle.reports.plugin.definition.
Report
Returns the report level columns in this report.
getReportsDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the Reports directory.
getRole(Object)
- Method in interface oracle.reports.server.
Security
Returns the role for a given user.
getRow()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getScale(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the scale of the column.
getSchemaName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Not used by the Reports Plugin API; simply stub it.
getServerDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the server directory.
getShort(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Short value.
getShort(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getSignOnParameter()
- Method in class oracle.reports.plugin.datasource.
PluginDataSourceTemplate
Returns the Sign-on Parameter of this Plugin Data Source.
getSignOnParametersOfSamePluginType()
- Method in class oracle.reports.plugin.definition.
DataSource
Returns the list of all Sign-on Parameters assigned to the same type of Plugin Data Sources.
getSize()
- Method in interface oracle.reports.cache.
CacheItem
Returns the item size expressed in bytes.
getSortOrder(int)
- Method in interface oracle.reports.plugin.
PluginResultSetMetaData
Returns the column's sort order.
getSortOrder(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Returns the sort order.
getStatement()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getString(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the String value.
getString(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getSystemParameters()
- Method in interface oracle.reports.server.
Job
Returns the system parameters.
getTableName(int)
- Method in class oracle.reports.plugin.
PluginResultSetMetaDataTemplate
Not used by the Reports Plugin API; simply stub it.
getTemplateDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the template directory.
getTemporaryDirectory()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the Reports temporary directory as defined by the REPORTS_TMP environment variable.
getTemporaryFile(String)
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns a unique temporary file in the Reports temporary directory defined by the REPORTS_TMP environment variable.
getTime(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Time value.
getTime(int, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTime(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTime(String, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTimestamp(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Returns the Timestamp value.
getTimestamp(int, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTimestamp(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTimestamp(String, Calendar)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getTrace()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the trace object.
getType()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getUnicodeStream(int)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getUnicodeStream(String)
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
getUserParameters()
- Method in interface oracle.reports.server.
Job
Returns the user parameters.
getValueIfNull()
- Method in class oracle.reports.plugin.definition.
Summary
Returns the "value if null" property of this column.
getValueIfNull()
- Method in class oracle.reports.plugin.definition.
Placeholder
Returns the "value if null" property of this column.
getValueIfNull()
- Method in class oracle.reports.plugin.definition.
DataSourceColumn
Returns the "value if null" property of this column.
getValueIfNull()
- Method in class oracle.reports.plugin.definition.
Formula
Returns the "value if null" property of this column.
getVersion()
- Method in class oracle.reports.plugin.definition.
ReportContext
Returns the Reports version.
getWarnings()
- Method in class oracle.reports.plugin.
PluginResultSetTemplate
Not used by the Reports Plugin API; simply stub it.
Group
- class oracle.reports.plugin.definition.
Group
.
The Reports group object.
Group(RWGroup, Report)
- Constructor for class oracle.reports.plugin.definition.
Group
Constructor.
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Oracle Reports
Java API Reference
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
A
B
C
D
E
F
G
H
I
J
L
M
N
O
P
R
S
T
U
W
Copyright © 2003 Oracle Corporation. All Rights Reserved.