oracle.reports.plugin.datasource
Interface PluginDataSourceFactory

All Superinterfaces:

PluginFactory

All Known Implementing Classes:

PluginDataSourceFactoryTemplate

public interface PluginDataSourceFactory

extends PluginFactory

Factory of Plugin Data Source, which is used to create Plugin Data Source instance as well as to hold the shared or even static information or behavior of this type of Plugin Data Source. When Reports creates and registers Plugin Data Source Factory with the following call sequence to relatet methods. Note setReportContext is called right after Plugin Data Source Factory is created. If Plugin Data Source Factory has any set-up based on Report Context (or the environment), it needs to be done inside setReportContext method. 1. PluginFactory() (default constructor) 2. setReportContext() 3. getHelpSet() 4. getHelpPrefix() 5. setHelpSetID() 6. needSignOnParameter() 7. getDefaultSignOnParameter()

Method Summary

java.lang.String	getDefaultSignOnParameter() Returns the name of 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 Reports Sign-on Parameter, false otherwise.
void	raiseConnectDialog(Parameter signOnParam) Raise connect dialog 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 Reports Sign-on Parameter, false otherwise. If this type of of Plugin Data Source does not need Sign-on Parameter, all Sign-in 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 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 returned default Sign-on Parameter does not exists 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

Raise connect dialog with the passed in Sign-on Parameter. Reports Build will invoke this method when the users click on the 'Connect' button in Sign-on Parameter's Property Palette.