Uses of Class
oracle.reports.plugin.PluginException

Packages that use PluginException

oracle.reports.plugin	Provides the API of the generic Reports Plugin component.
oracle.reports.plugin.datasource	Provides the API of the Reports Plugin Data Source, which is a subclass of the generic Reports Plugin component.
oracle.reports.plugin.definition	Provides Java classes representing Report context and Reports objects for the Plugin to access Reports environment information, such as command line parameters, locale, and Reports objects in the same report.

Uses of PluginException in oracle.reports.plugin

Methods in oracle.reports.plugin that throw PluginException

boolean	PluginEditor.edit(Plugin plugin) Provides the edit function for the plugin.
int	PluginFactory.getMajorVersion() Returns the major version of the plugin.
int	PluginFactory.getMinorVersion() Returns the minor version of the plugin.
java.lang.String	PluginFactory.getIconName() Returns the icon name of the plugin.
java.lang.String	PluginFactory.getName() Returns the name of this type of plugin.
java.lang.String	PluginFactory.getHint() Returns the hint message of this type of plugin.
void	PluginFactory.setHelpSetID(java.lang.String helpSetID) Sets the helpset ID for the plugin.
java.lang.String	PluginFactory.getHelpSet() Returns the full path of the helpset file or a URL to the helpset file.
java.lang.String	PluginFactory.getHelpPrefix() Returns the prefix string for the error message help (e.g., "XR" for Express).
PluginEditor	PluginFactory.getEditor() Returns the plugin's editor.
Plugin	PluginFactory.make() Makes a plugin instance.
void	PluginFactory.dispose() Removes the plugin instance and cleans up related resources.
boolean	PluginEditorTemplate.edit(Plugin plugin) Displays the Plugin Data Source's dialog box.
int	PluginResultSetMetaData.getSortOrder(int colIdx) Returns the column's sort order.
int	PluginResultSetMetaData.sortColumnOf(int colIdx) Returns the base column index of the column if it is a sort column.
ReportContext	PluginFactoryTemplate.getReportContext() Returns the Report Context, which is passed in to setReportContext.
void	PluginFactoryTemplate.setHelpSetID(java.lang.String helpSetID) Sets the helpset ID for the plugin.
PluginEditor	PluginFactoryTemplate.getEditor() Returns the plugin's editor.
Plugin	PluginFactoryTemplate.make() Makes a new plugin instance.
int	PluginResultSetMetaDataTemplate.sortColumnOf(int column) Returns the SortColumnOf value.
int	PluginResultSetMetaDataTemplate.getSortOrder(int column) Returns the sort order.
void	Plugin.startRuntime() Notifies the plugin that Reports is about to start to run.
boolean	Plugin.applyXML(java.lang.String xml) Applies a text definition (usually in XML) to the plugin.
java.lang.String	Plugin.saveToXML() Returns the text definition (usually in XML) of the plugin.
void	Plugin.setFactory(PluginFactory fac) Sets the factory object that creates this plugin.
PluginFactory	Plugin.getFactory() Returns the factory object that creates the plugin.

Uses of PluginException in oracle.reports.plugin.datasource

Methods in oracle.reports.plugin.datasource that throw PluginException

boolean	PluginDataSourceFactory.needSignOnParameter() Returns true if this type of Plugin Data Source needs to make use of the Reports Sign-on Parameter, false otherwise.
java.lang.String	PluginDataSourceFactory.getDefaultSignOnParameter() Returns the name of the default Sign-on Parameter of this type of Plugin Data Source.
void	PluginDataSourceFactory.raiseConnectDialog(Parameter signOnParam) Raises the Connect dialog box with the passed in Sign-on Parameter.
java.lang.String[]	PluginDataSourceTemplate.getReferencedColumns() The Template Plugin Data Source does not reference Reports columns.
void	PluginDataSourceTemplate.startRuntime() The Template Plugin Data Source does not need any initialization before runtime.
void	PluginDataSourceTemplate.setFactory(PluginFactory fac) Sets the factory that creates the plugin.
PluginFactory	PluginDataSourceTemplate.getFactory() Returns the factory passed to setFactory.
DataSource	PluginDataSourceTemplate.getDataSource() Returns the hosting Reports data source object of the plugin.
Report	PluginDataSourceTemplate.getReport() Returns the hosting report of the plugin.
ReportContext	PluginDataSourceTemplate.getReportContext() Returns the report context, which provides environment information.
void	PluginDataSourceTemplate.setSignOnParameter(Parameter signOnParam) Sets the Sign-on Parameter of this Plugin Data Source whenever it is set or changed in the Reports Property Inspector.
Parameter	PluginDataSourceTemplate.getSignOnParameter() Returns the Sign-on Parameter of this Plugin Data Source.
boolean	PluginDataSourceTemplate.applyXML(java.lang.String xml) The Template Data Source has only static definition for sample code purposes.
void	PluginDataSourceTemplate.setDataSource(DataSource datasource) Sets the Reports hosting data source object of the plugin.
java.lang.String	PluginDataSourceTemplate.getQueryDescription() Returns the highlight data source description to be displayed in the Reports Wizard Data page.
PluginResultSetMetaData	PluginDataSourceTemplate.describe() Returns static meta-data of the Template Plugin Data Source.
java.sql.ResultSet	PluginDataSourceTemplate.execute(java.lang.Object[] refedColVals, PluginCondition[] conds, int maxrows) Returns static result set of the Template Plugin Data Source.
boolean	PluginDataSourceTemplate.supportCondition() The Template Plugin Data Source does not support conditions, so returns false.
java.lang.String	PluginDataSourceTemplate.saveToXML() Returns the static definition to be saved with report.
void	PluginDataSource.setSignOnParameter(Parameter signOnParam) Sets the Sign-on Parameter of this Plugin Data Source.
java.lang.String[]	PluginDataSource.getReferencedColumns() Returns the names of the Reports columns whose values will be used in the Plugin Data Source's execution.
java.lang.String	PluginDataSource.getQueryDescription() Returns the text description of the query, which usually contains the information of the source, columns, and bind variables.
void	PluginDataSource.setDataSource(DataSource datasource) Sets the hosting Reports data source object of this Plugin Data Source.
PluginResultSetMetaData	PluginDataSource.describe() Returns the result set meta information of the data source.
boolean	PluginDataSource.supportCondition() Returns true or false, depending on whether the Plugin Data Source supports conditions.
java.sql.ResultSet	PluginDataSource.execute(java.lang.Object[] refedColVals, PluginCondition[] conds, int maxrows) Executes the Plugin Data Source and returns the result set.
boolean	PluginDataSourceFactoryTemplate.needSignOnParameter() The Template Data Source does not support the Sign-on Parameter.
java.lang.String	PluginDataSourceFactoryTemplate.getDefaultSignOnParameter() The Template Data Source does not support the Sign-on Parameter.
void	PluginDataSourceFactoryTemplate.raiseConnectDialog(Parameter signOnParam) The Template Data Source does not support the Sign-on Parameter.

Uses of PluginException in oracle.reports.plugin.definition

Methods in oracle.reports.plugin.definition that throw PluginException

Report	BaseObject.getReport() Returns the report of the object.
java.lang.String	BaseObject.getName() Returns the name of the object.
java.lang.String	BaseObject.getComment() Returns the comment of the object.
ReportContext	Report.getReportContext() Returns the context object of the report.
Column[]	Report.getAllColumns() Returns all columns in this report.
DataSource[]	Report.getDataSources() Returns the data sources in this report.
Column[]	Report.getReportLevelColumns() Returns the report level columns in this report.
Group	Report.getFirstGroup() Returns the first group in this report.
int	Column.getDataType() Returns the data type of this column.
Group	Column.getGroup() Returns the group of this column.
static Column	Column.createColumn(oracle.reports.definition.RWDataItem rwdataitem, Report report) Creates a column object.
java.lang.String	Summary.getValueIfNull() Returns the "value if null" property of this column.
java.lang.String	Placeholder.getValueIfNull() Returns the "value if null" property of this column.
DataSource	Group.getDataSource() Returns the data source of this group.
Column[]	Group.getColumns() Returns the columns in this group.
Group	Group.getNextSibling() Returns the next sibling group of this group.
Group	Group.getPreviousSibling() Returns the previous sibling group of this group.
Group	Group.getFirstChild() Returns the first child group of this group.
Group	Group.getParent() Returns the parent group of this group.
boolean	Parameter.isUserParameter() Returns true if this parameter is a user parameter; false if not.
boolean	Parameter.isSystemParameter() Returns true if this parameter is a system parameter; false if not.
java.lang.String	Parameter.getCurrentValue() Returns the current value of this parameter.
java.lang.String	Parameter.getInitialValue() Returns the initial value of this parameter.
Parameter[]	DataSource.getSignOnParametersOfSamePluginType() Returns the list of all Sign-on Parameters assigned to the same type of Plugin Data Sources.
void	DataSource.setSignOnParameter(java.lang.String paramName) Sets the Sign-on Parameter of this Plugin Data Source.
Group[]	DataSource.getGroups() Returns the groups of this data source.
boolean	ReportContext.isInsideReportsBuilder() Returns true if the current context is running inside Reports Builder.
boolean	ReportContext.isUIAllowedNow() Returns true if the plugin is allowed to raise its UI (for example, the Connect dialog box) at this moment.
Trace	ReportContext.getTrace() Returns the trace object.
java.lang.String	ReportContext.findFileInReportsPath(java.lang.String filename) Searches for a file named in paths specified by the REPORTS_PATH environment variable.
java.util.Locale	ReportContext.getLocale()
java.lang.String	ReportContext.getPluginParam(java.lang.String name) Returns the named plugin parameter from the server configuration file.
void	ReportContext.showHelpContent(java.lang.String helpSetID) Displays the help content.
void	ReportContext.showHelpTopic(java.lang.String helpSetID, java.lang.String topicID) Displays the help topic.
java.util.Hashtable	ReportContext.getCommandLineArguments() Returns the command line arguments.
java.lang.String	ReportContext.getReportsDirectory() Returns the Reports directory.
java.lang.String	ReportContext.getConfigDirectory() Returns the configuration directory.
java.lang.String	ReportContext.getCacheDirectory() Returns the cache directory.
java.lang.String	ReportContext.getDTDDirectory() Returns the DTD directory.
java.lang.String	ReportContext.getOracleHome() Returns the ORACLE_HOME directory.
java.lang.String	ReportContext.getServerDirectory() Returns the server directory.
java.lang.String	ReportContext.getTemplateDirectory() Returns the template directory.
java.lang.String	ReportContext.getTemporaryDirectory() Returns the Reports temporary directory as defined by the REPORTS_TMP environment variable.
java.lang.String	ReportContext.getTemporaryFile(java.lang.String basename) Returns a unique temporary file in the Reports temporary directory defined by the REPORTS_TMP environment variable.
java.lang.String	ReportContext.getVersion() Returns the Reports version.
java.lang.String	DataSourceColumn.getValueIfNull() Returns the "value if null" property of this column.
java.lang.String	Formula.getValueIfNull() Returns the "value if null" property of this column.

Constructors in oracle.reports.plugin.definition that throw PluginException

BaseObject(oracle.reports.definition.RWObject rwobj, Report report)
Constructor.

Report(oracle.reports.definition.RWReport rwreport, ReportContext reportContext)
Constructor.

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

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

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

Group(oracle.reports.definition.RWGroup rwobj, Report report)
Constructor.

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

DataSource(oracle.reports.definition.RWDataSource rwobj, Report report)
Constructor.

ReportContext(oracle.reports.definition.RWReport rwobj, Trace trace)
Constructor.

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

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