Oracle Reports
Java API Reference
11g Release 1 (11.1.1)
E10775-01
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 Plugin API, simply stub it.
getArray(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getAsciiStream(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getAsciiStream(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBigDecimal(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns BigDecimal value.
getBigDecimal(int, int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBigDecimal(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBigDecimal(String, int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBinaryStream(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBinaryStream(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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 Plugin API, simply stub it.
getBlob(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBoolean(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns boolean value.
getBoolean(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getByte(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getByte(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBytes(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getBytes(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getCacheDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns 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 Reports Plugin API, simply stub it.
getCharacterStream(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getCharacterStream(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getClob(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getClob(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getColumn() - Method in class oracle.reports.plugin.PluginCondition
Returns the index of the column which the condition applies
getColumnClassName(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Not used by Reports Plugin API, simply stub it.
getColumnCount() - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Returns number of columns.
getColumnDisplaySize(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Return display size.
getColumnLabel(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Returns column label.
getColumnName(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Return 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 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 Plugin API, simply stub it.
getConfigDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns config directory
getContent(String) - Method in interface oracle.reports.cache.CacheItem
Returns file content from the cache.
getContent(String) - Method in class oracle.reports.server.Destination
Returns the contents of a file 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 current value of this parameter
getCursorName() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getDataSource() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Gets the hosting Reports data source object of the Plugin.
getDataSource() - Method in class oracle.reports.plugin.definition.Group
Returns the data source of this group
getDataSources() - Method in class oracle.reports.plugin.definition.Report
Returns 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 Date value.
getDate(int, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getDate(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getDate(String, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getDefaultSignOnParameter() - Method in interface oracle.reports.plugin.datasource.PluginDataSourceFactory
Returns the name of default Sign-on Parameter of this type of Plugin Data Source.
getDefaultSignOnParameter() - Method in class oracle.reports.plugin.datasource.PluginDataSourceFactoryTemplate
Template Data Source does not support sign-on parameter.
getDesname() - Method in class oracle.reports.server.Destination
Returns the destination name (DESNAME) of the object.
getDestinationId() - Method in class oracle.reports.server.Destination
 
getDestKey() - Method in class oracle.reports.server.Destination
 
getDestype() - Method in class oracle.reports.server.Destination
Returns the destination type (DESTYPE) of the object.
getDomains() - Method in class oracle.reports.plugin.definition.ReportContext
 
getDouble(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns double value.
getDouble(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getDTDDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns DTD directory
getDuplicatedJob() - Method in interface oracle.reports.server.Job
Returns the duplicated job.
getEditor() - Method in interface oracle.reports.plugin.PluginFactory
Gets Plugin Editor
getEditor() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns Plug-in's Editor
getEditorClass() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns Plug-in Editor class name.
getErrorCode() - Method in exception 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 class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Gets the factory passed to setFactory.
getFactory() - Method in interface oracle.reports.plugin.Plugin
Gets the factory object which creates this plugin.
getFetchDirection() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getFetchSize() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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 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 float value.
getFloat(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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
Gets prefix string for the error message help.
getHelpPrefix() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Gets prefix string for the error message help.
getHelpSet() - Method in interface oracle.reports.plugin.PluginFactory
Gets the full path of helpset file or a URL to the helpset file If not implemented, this plugin is helpless ;-)
getHelpSet() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns the full path of 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 Plug-in class name.
getHoldability() - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getIconName() - Method in interface oracle.reports.plugin.PluginFactory
Returns icon name of the Plug-in.
getIconName() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns icon name of the Plug-in.
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 initial value of this parameter
getInt(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns int value.
getInt(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getJob() - Method in interface oracle.reports.cache.CacheItem
Returns the job owning this CacheItem.
getJob() - Method in class oracle.reports.server.Destination
Returns the job object to which the destination object attaches.
getJobInfo() - Method in interface oracle.reports.server.Job
Returns the job info.
getKey() - Method in interface oracle.reports.cache.CacheItem
Returns the Item Key.
getKey() - Method in interface oracle.reports.engine.EngineInterface
Returns the engine key that is used while accessing the engine object.
getLocale() - Method in class oracle.reports.plugin.definition.ReportContext
 
getLong(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns long value.
getLong(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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 Factory.
getMajorVersion() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns major version.
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 Factory
getMinorVersion() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns minor version.
getModule() - Method in exception oracle.reports.plugin.PluginException
Returns the name of the module which raised the exception
getName() - Method in class oracle.reports.plugin.definition.BaseObject
Returns the name of the object
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 Plug-in name.
getName() - Method in interface oracle.reports.server.Security
Returns the name of the security system.
getNCharacterStream(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getNCharacterStream(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getNClob(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getNClob(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getNextSibling() - Method in class oracle.reports.plugin.definition.Group
Returns the next sibling group of this group
getNString(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getNString(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getObject(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns object value.
getObject(int, Map) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getObject(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getObject(String, Map) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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 ORACLE_HOME directory
getParameters() - Method in interface oracle.reports.server.Job
Returns all parameters.
getParent() - Method in class oracle.reports.plugin.definition.Group
Returns parent group of this group
getPluginClass() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns Plug-in class name.
getPluginParam(String) - Method in class oracle.reports.plugin.definition.ReportContext
Get the named plugin param from the server config file
getPluginParam(String) - Method in class oracle.reports.server.Destination
Returns the plugin parameter value given the parameter name.
getPrecision(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Return 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.
getProxyInfo() - Method in class oracle.reports.plugin.definition.ReportContext
 
getQueryDescription() - Method in interface oracle.reports.plugin.datasource.PluginDataSource
Gets text description of the query, which usually contains the information of the source, columns, and bind variables.
getQueryDescription() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Returns the high-light data source description to be displayed in Reports Wizard Data Tab.
getRef(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getRef(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getReferencedColumns() - Method in interface oracle.reports.plugin.datasource.PluginDataSource
Gets the names of the Reports columns whose values will be used in Plugin Data Source's execution.
getReferencedColumns() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Template Plug-in Data Source does not reference Reports columns.
getReport() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Gets the hosting report of the plugin.
getReport() - Method in class oracle.reports.plugin.definition.BaseObject
Returns the report of the object
getReportContext() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Gets the report context which provides environment information.
getReportContext() - Method in class oracle.reports.plugin.definition.Report
Returns the context object of the report.
getReportContext() - Method in class oracle.reports.plugin.PluginFactoryTemplate
Returns Report Context which is passed in to setReportContext.
getReportLevelColumns() - Method in class oracle.reports.plugin.definition.Report
Returns 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 Plugin API, simply stub it.
getRowId(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getRowId(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getRunCounter() - Method in interface oracle.reports.server.Job
Returns the number of times this job has run (applicable only for scheduled jobs).
getScale(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Return the scale of the column.
getSchemaName(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Not used by Reports Plugin API, simply stub it.
getServerDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns server directory
getShort(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns short value.
getShort(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getSignOnParameter() - Method in class oracle.reports.plugin.datasource.PluginDataSourceTemplate
Return sign-on parameter of this Plug-in 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 column's sort order, how Reports should sort rows based on this column:
getSortOrder(int) - Method in class oracle.reports.plugin.PluginResultSetMetaDataTemplate
Return the sort order.
getSQLXML(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getSQLXML(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getStatement() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getStaticProperties() - Static method in class oracle.reports.server.Destination
 
getString(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns String value.
getString(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by 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 Reports Plugin API, simply stub it.
getTemplateDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns template directory
getTemporaryDirectory() - Method in class oracle.reports.plugin.definition.ReportContext
Returns Reports temporary directory as defined by REPORTS_TMP environment variable
getTemporaryFile(String) - Method in class oracle.reports.plugin.definition.ReportContext
Returns a unique temporary file in Reports temporary directory defined by REPORTS_TMP environment variable This method only returns a unique filename for you, no file is created.
getTime(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns Time value.
getTime(int, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTime(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTime(String, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTimestamp(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Returns Timestamp value.
getTimestamp(int, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTimestamp(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTimestamp(String, Calendar) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getTrace() - Method in class oracle.reports.plugin.definition.ReportContext
Returns trace object
getTraceFlag() - Method in class oracle.reports.plugin.utility.Trace
Returns the trace option set in the confuguration file
getType() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getUnicodeStream(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getUnicodeStream(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
getURL(int) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getURL(String) - Method in class oracle.reports.plugin.PluginResultSetTemplate
 
getUserParameters() - Method in interface oracle.reports.server.Job
Returns the user parameters.
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
Gets "value if null" property of this column
getValueIfNull() - Method in class oracle.reports.plugin.definition.Placeholder
Returns "value if null" property of this column
getValueIfNull() - Method in class oracle.reports.plugin.definition.Summary
Returns "value if null" property of this column
getVersion() - Method in class oracle.reports.plugin.definition.ReportContext
Returns Reports version
getWarnings() - Method in class oracle.reports.plugin.PluginResultSetTemplate
Not used by Plugin API, simply stub it.
Group - Class in oracle.reports.plugin.definition
Report group object
Group(RWGroup, Report) - Constructor for class oracle.reports.plugin.definition.Group
Constructor NOTE: Plugin must never try to create any Reports objects itself.

Oracle Reports
Java API Reference
A B C D E F G H I J L M N O P R S T U W
Copyright © 1994, 2009 Oracle Corporation. All Rights Reserved.