com.businessobjects.customds.ui
Class AbstractCustomDSExtension

java.lang.Object
  com.businessobjects.customds.ui.AbstractCustomDSExtension

All Implemented Interfaces:

CustomDSExtension

public abstract class AbstractCustomDSExtension
extends java.lang.Object
implements CustomDSExtension

AbstractCustomDSComponent is an abstract implementation class for CustomDSExtension.

This class provides default implementation for a few methods in CustomDSExtension. Methods that require plug-in specific implementation must be implemented by plug-in developers.

Since:

12.2

Constructor Summary

AbstractCustomDSExtension()

Method Summary

void	clean() Default empty implementation.
javax.swing.ImageIcon	getDataProviderIcon() Returns null.
java.lang.String	getDataSourceDescription() Returns null.
java.lang.String	getDisplayName() Returns null.
java.lang.String	getFileExtnDescription() Returns null.
java.lang.String	getHelpURL() Returns null.
java.lang.String	getHelpURL(java.lang.String context, java.lang.String errorMessage) Returns null.
javax.swing.ImageIcon	getImageIcon() Returns null.
java.lang.String	getNewActionText() Returns empty String.
java.lang.String	getNewActionTooltip() Returns empty String.
javax.swing.ImageIcon	getNewDataProviderIcon() Returns null.
void	init(SessionInfo sessInfo) Stores the complete SessionInfo information.
boolean	isExtensionHelpAvailable() Returns false.
void	setLocale(java.util.Locale loc) Stores the provided interface Locale information.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.businessobjects.customds.ui.CustomDSExtension

getCDSComponent, getExtensionDescriptor

Constructor Detail

AbstractCustomDSExtension

public AbstractCustomDSExtension()

Method Detail

clean

public void clean()

Default empty implementation.

Specified by:

clean in interface CustomDSExtension

See Also:

CustomDSExtension.clean()

getDisplayName

public java.lang.String getDisplayName()

Returns null.

Specified by:

getDisplayName in interface CustomDSExtension

Returns:

null

See Also:

CustomDSExtension.getDisplayName()

getDataSourceDescription

public java.lang.String getDataSourceDescription()
                                          throws CDSExtensionException

Returns null.

Specified by:

getDataSourceDescription in interface CustomDSExtension

Returns:

null

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to get the data source description.

See Also:

CustomDSExtension.getDataSourceDescription()

getFileExtnDescription

public java.lang.String getFileExtnDescription()

Returns null.

Specified by:

getFileExtnDescription in interface CustomDSExtension

Returns:

null

See Also:

CustomDSExtension.getFileExtnDescription()

getHelpURL

public java.lang.String getHelpURL()

Returns null.

Specified by:

getHelpURL in interface CustomDSExtension

Returns:

null

See Also:

CustomDSExtension.getHelpURL()

getHelpURL

public java.lang.String getHelpURL(java.lang.String context,
                                   java.lang.String errorMessage)

Returns null.

Specified by:

getHelpURL in interface CustomDSExtension

Parameters:

context - The current context of user workflow

errorMessage - The error message, if any. May be null.

Returns:

null

See Also:

CustomDSExtension.getHelpURL(java.lang.String, java.lang.String)

getImageIcon

public javax.swing.ImageIcon getImageIcon()
                                   throws CDSExtensionException

Returns null.

Specified by:

getImageIcon in interface CustomDSExtension

Returns:

null

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to provide the image icon.

See Also:

CustomDSExtension.getImageIcon()

getDataProviderIcon

public javax.swing.ImageIcon getDataProviderIcon()
                                          throws CDSExtensionException

Returns null.

Specified by:

getDataProviderIcon in interface CustomDSExtension

Returns:

null

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to provide the image icon.

See Also:

CustomDSExtension.getDataProviderIcon()

getNewDataProviderIcon

public javax.swing.ImageIcon getNewDataProviderIcon()
                                             throws CDSExtensionException

Returns null.

Specified by:

getNewDataProviderIcon in interface CustomDSExtension

Returns:

null

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to provide the image icon.

See Also:

CustomDSExtension.getNewDataProviderIcon()

getNewActionText

public java.lang.String getNewActionText()
                                  throws CDSExtensionException

Returns empty String.

Specified by:

getNewActionText in interface CustomDSExtension

Returns:

null

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to get the action text for the new data provider.

See Also:

CustomDSExtension.getNewActionText()

getNewActionTooltip

public java.lang.String getNewActionTooltip()
                                     throws CDSExtensionException

Returns empty String.

Specified by:

getNewActionTooltip in interface CustomDSExtension

Returns:

String

Throws:

CDSExtensionException - if the plug-in encounters any Exception while trying to get the action tooltip for the new data provider.

See Also:

CustomDSExtension.getNewActionTooltip()

init

public void init(SessionInfo sessInfo)
          throws CDSExtensionException

Stores the complete SessionInfo information.

Sub-classes can access this information through the member variable sessionInfo.

This method also stores the interface locale to the value provided in the SessionInfo. Sub-classes can access this information through the member variable interfaceLocale.

Specified by:

init in interface CustomDSExtension

Parameters:

sessInfo - The session information.

Throws:

CDSExtensionException - if the plug-in encounters any Exception while processing the initial set of information.

See Also:

CustomDSExtension.init(com.businessobjects.customds.ui.common.SessionInfo)

isExtensionHelpAvailable

public boolean isExtensionHelpAvailable()

Returns false.

Specified by:

isExtensionHelpAvailable in interface CustomDSExtension

Returns:

false

See Also:

CustomDSExtension.isExtensionHelpAvailable()

setLocale

public void setLocale(java.util.Locale loc)

Stores the provided interface Locale information.

Sub-classes can access this information through the member variable interfaceLocale.

Specified by:

setLocale in interface CustomDSExtension

Parameters:

loc - The Locale information.

See Also:

CustomDSExtension.setLocale(java.util.Locale)