com.businessobjects.customds.ui
Interface CustomDSComponent

All Known Implementing Classes:

AbstractCustomDSComponent

public interface CustomDSComponent

The CustomDSComponent is a helper interface that provides user interface component to the Framework.

This is the main interface that interacts with the Interactive Analysis Server / Processing layer plug-in implementation. After sending the source information, the Framework gets the initial set of parameters from the server side plug-in, which is then used by this plug-in to build the user interface. When the user selects the options provided, framework attempts to get the updated parameters by calling the CustomDSComponent.getUpdatedDSParams() method. The updated parameters are sent to the server side plug-in for further processing. Depending on the server-side plug-in's ability to interpret the updated parameters, it either sends the new set of parameters or returns the initial list if it does not have all the information to access the data source.

If the server-side plug-in does not have all the information to access the data source, the Framework invokes the CustomDSComponent.processMissingDSParams(Map) method with the data source parameters provided by the server side plug-in. The parameters are interpreted as part of the current set if the server side plug-in detects that user has not provided the correct information required for accessing the data source. In this case, the plug-in must alert the user about missing information. In the case of incremental building of information for accessing the data source, it can be a new set of parameters rather than the missing one.

Though a wizard-like flow is possible through incremental access of data source, the Framework does not support the capabilities of an actual wizard. A major limitation in this regard is the "Back" button. For edit operations, it is recommended that plug-in implementer must use the panel that appears before the Query panel. (that is, the last selection in the user interface for data source inputs).

Since:

12.2

See Also:

CDSExtensionException

Method Summary

void	free() Notifies the plug-in to do any clean-up activities for the user interface component.
java.lang.String	getActionTitle() Implementation of this method must return the localized String of the current action that user is expected to perform on the user interface component.
javax.swing.JComponent	getUIComponent() Implementation of this method must return the plug-in's user interface component.
java.util.Map	getUpdatedDSParams() Implementation of this method must return the updated data source parameters from the plug-in.
void	processMissingDSParams(java.util.Map dsParams) Invoked by the Framework to enable the plug-in process missing / new set of data source parameters.

Method Detail

getUIComponent

javax.swing.JComponent getUIComponent()
                                      throws CDSExtensionException

Implementation of this method must return the plug-in's user interface component.

Returns:

The user interface component.

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to provide the user interface component.

See Also:

CDSExtensionException

getActionTitle

java.lang.String getActionTitle()

Implementation of this method must return the localized String of the current action that user is expected to perform on the user interface component.

Returns:

The action title.

getUpdatedDSParams

java.util.Map getUpdatedDSParams()
                                 throws CDSExtensionException

Implementation of this method must return the updated data source parameters from the plug-in. This method is called after user clicks the "NEXT" button. This method is mainly used to obtain the user input that is provided to the server side plug-in to access the data source.

Returns:

The Map containing updated data source parameters.

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to provide the updated Map of data source parameters.

See Also:

CDSExtensionException

processMissingDSParams

void processMissingDSParams(java.util.Map dsParams)
                            throws CDSExtensionException

Invoked by the Framework to enable the plug-in process missing / new set of data source parameters.

Parameters:

dsParams - The map containing data source parameters as provided by the data provider source plug-in.

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to process missing data source parameters.

See Also:

CDSExtensionException

free

void free()

Notifies the plug-in to do any clean-up activities for the user interface component.

This call marks the end of life-cycle of the plug-in's user interface component.