com.businessobjects.customds.ui.common
Interface SessionInfo

public interface SessionInfo

The SessionInfo interface provides some of the current user session information and also a few environment details that are related to product installation.

Since:

12.2

Method Summary

ClientType	getClientType() Returns type of client where the plug-in is used with the current deployment.
java.lang.String	getDataSourceType() Returns the data source type of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getDataSourceType().
java.lang.String	getExtensionName() Returns the extension name of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getName().
java.lang.String	getExtensionVersion() Returns the extension version of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getVersion().
java.util.Locale	getInterfaceLocale() Returns the user interface locale as provided by the Framework.
java.lang.String	getProductClassesDir() Deprecated. since 14.0, use the path provided by method SessionInfo.getSharedClassesDir() instead.
java.lang.String	getProductHelpPath() Returns the root help path of the SAP BusinessObjects installation.
java.lang.String	getSessionID() Returns the current user session ID generated during login.
java.lang.String	getSharedClassesDir() Returns the location of the SAP BusinessObjects install shared classes directory.

Method Detail

getSessionID

java.lang.String getSessionID()

Returns the current user session ID generated during login.

This method may return an empty string if the session ID information is not available. For example, when CustomDSExtension.init is called.

Returns:

The session ID.

Since:

12.2

getInterfaceLocale

java.util.Locale getInterfaceLocale()

Returns the user interface locale as provided by the Framework. This locale can be used by the plug-in to display locale-specific information.

Returns:

The user interface locale.

Since:

12.2

getProductClassesDir

@Deprecated
java.lang.String getProductClassesDir()

Deprecated. since 14.0, use the path provided by method SessionInfo.getSharedClassesDir() instead.

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

Returns:

The default classes directory path

Since:

12.2

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

getProductHelpPath

java.lang.String getProductHelpPath()

Returns the root help path of the SAP BusinessObjects installation. This method may return an empty string if the root help path is not known to the Framework.

Returns:

The root help path

Since:

12.2

getDataSourceType

java.lang.String getDataSourceType()

Returns the data source type of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getDataSourceType().

The plug-in's data source type is internally considered as a data source sub-type by the Framework.

Returns:

The data source type.

Since:

12.2

getExtensionName

java.lang.String getExtensionName()

Returns the extension name of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getName().

Returns:

The extension name.

Since:

12.2

getExtensionVersion

java.lang.String getExtensionVersion()

Returns the extension version of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getVersion().

Returns:

The extension version.

Since:

12.2

getClientType

ClientType getClientType()

Returns type of client where the plug-in is used with the current deployment.

May return null if the information is not known to the framework.

Returns:

The client type.

Since:

14.0

See Also:

ClientType