com.businessobjects.customds.common
Interface CustomDataSourceInfo

public interface CustomDataSourceInfo

The CustomDataSourceInfo interface is used to return the basic information required by the plug-in (extension) for accessing the data source.

The implementation object of this interface is sent while calling the CustomDataSource.init(CustomDataSourceInfo) method.

Plug-in information is provided to enable single data provider source implementation with multiple user interface implementations.

Since:

12.2

Method Summary

java.lang.String	getCESessionID() Returns the CE session ID of the Interactive Analysis Client.
java.lang.String	getClientName() Returns the name of the Interactive Analysis client used for invoking the current workflow.
java.lang.String	getDataSourceType() Returns the data source type of the plug-in (extension).
DeploymentContext	getDeploymentContext() Returns the deployment context for the current workflow.
java.lang.String	getExtensionName() Returns the extension name of the plug-in (extension).
java.lang.String	getExtensionVersion() Returns the extension version of the plug-in (extension).
java.util.Locale	getInterfaceLocale() Returns the interface locale of the Interactive Analysis Client.
java.lang.String	getServerPath() Returns the physical storage path of the Data Source on the Interactive Analysis Server machine.
java.lang.String	getSharedClassesDir() Returns the location of the SAP BusinessObjects install shared classes directory.
java.lang.String	getSource() Returns the source (file path / URL), if any, as provided by the user; otherwise empty string.

Method Detail

getDataSourceType

java.lang.String getDataSourceType()

Returns the data source type of the plug-in (extension).

The data source type is internally treated as data source sub-type.

Returns:

the data source type.

Since:

12.2

getExtensionName

java.lang.String getExtensionName()

Returns the extension name of the plug-in (extension).

Returns:

the extension name.

Since:

12.2

getExtensionVersion

java.lang.String getExtensionVersion()

Returns the extension version of the plug-in (extension).

Returns:

the extension version.

Since:

12.2

getSource

java.lang.String getSource()

Returns the source (file path / URL), if any, as provided by the user; otherwise empty string.

Returns:

the source required, if any, by the plug-in to access the data source; otherwise empty string.

Since:

12.2

getInterfaceLocale

java.util.Locale getInterfaceLocale()

Returns the interface locale of the Interactive Analysis Client.

Returns:

the interface locale of the Interactive Analysis Client.

Since:

12.2

getCESessionID

java.lang.String getCESessionID()

Returns the CE session ID of the Interactive Analysis Client.

Returns:

the CE session ID of the Interactive Analysis Client.

Since:

12.2

getServerPath

java.lang.String getServerPath()

Returns the physical storage path of the Data Source on the Interactive Analysis Server machine. In case of failure to locate the Data Source on the original path specified during creation of Interactive Analysis document, the data source should be looked into this location. This applies only for "FILE" based CDP Framework plug-ins.

Returns:

the physical storage path of the Data Source.

Since:

12.3

getSharedClassesDir

java.lang.String getSharedClassesDir()

Returns the location of the SAP BusinessObjects install shared classes directory. This method may return an empty string if the common classes directory is not known to the Framework.

Returns:

The shared classes directory path

Since:

14.0

getDeploymentContext

DeploymentContext getDeploymentContext()

Returns the deployment context for the current workflow. Possible deployment context values can be Enterprise or Desktop. It may return Undefined if the deployment context is not known to the framework

Returns:

the deployment workflow

Since:

14.0

getClientName

java.lang.String getClientName()

Returns the name of the Interactive Analysis client used for invoking the current workflow.

Returns:

The name of Interactive Analysis Client

Since:

14.0