oracle.reports.plugin.datasource
Interface PluginDataSourceFactory

All Superinterfaces:

PluginFactory

All Known Implementing Classes:

PluginDataSourceFactoryTemplate

public interface PluginDataSourceFactory

extends PluginFactory

Factory of the Plugin Data Source. Creates a Plugin Data Source instance and holds the shared or even static information or behavior of this type of Plugin Data Source. Reports creates and registers the Plugin Data Source Factory with the following call sequence to related methods:

  1. PluginFactory() (default constructor)
  2. setReportContext()
  3. getHelpSet()
  4. getHelpPrefix()
  5. setHelpSetID()
  6. needSignOnParameter()
  7. getDefaultSignOnParameter()

Note that setReportContext is called right after the Plugin Data Source Factory is created. If the Plugin Data Source Factory has any setup based on Report Context (or the environment), it needs to be done inside the setReportContext method.

Method Summary

java.lang.String	getDefaultSignOnParameter() Returns the name of the default Sign-on Parameter of this type of Plugin Data Source.
boolean	needSignOnParameter() Returns true if this type of Plugin Data Source needs to make use of the Reports Sign-on Parameter, false otherwise.
void	raiseConnectDialog(Parameter signOnParam) Raises the Connect dialog box with the passed in Sign-on Parameter.

Methods inherited from interface oracle.reports.plugin.PluginFactory

dispose, getEditor, getHelpPrefix, getHelpSet, getHint, getIconName, getMajorVersion, getMinorVersion, getName, make, setHelpSetID, setReportContext

Method Detail

needSignOnParameter

public boolean needSignOnParameter()
                            throws PluginException

Returns true if this type of Plugin Data Source needs to make use of the Reports Sign-on Parameter, false otherwise. If this type of Plugin Data Source does not need the Sign-on Parameter, all Sign-on Parameter related UI and Plugin API will be disabled for this type of Plugin Data Source.

getDefaultSignOnParameter

public java.lang.String getDefaultSignOnParameter()
                                           throws PluginException

Returns the name of the default Sign-on Parameter of this type of Plugin Data Source. The default Sign-on Parameter will be assigned to each Plugin Data Source of this type when it is created. If the returned default Sign-on Parameter does not exist yet, Reports will automatically create it when the first Plugin Data Source of this type is created.

raiseConnectDialog

public void raiseConnectDialog(Parameter signOnParam)
                        throws PluginException

Raises the Connect dialog box with the passed in Sign-on Parameter. Reports Builder will invoke this method when users click the 'Connect' button in the Sign-on Parameter's Property Inspector.