com.businessobjects.customds.ui.common
Interface DataHolder

public interface DataHolder

The DataHolder interface is used to obtain data that is useful in creating the user interface.

The plug-in must use this interface to fetch the required data from the object passed by the Framework.

Since:

12.2

Method Summary

java.util.Map	getDSParameters() Returns the Map that contains the data source parameters as supplied by the server-side/processing layer plug-in.
java.lang.String	getDSPath() Returns the specified data source path for plug-ins with "FILE" or "URL" resource type(The value provided by the plug-in for call to CDSExtensionDescriptor.getDSResourceType()).
java.awt.Font	getFont() Returns the interface font that is currently in use.
SessionInfo	getSessionInfo() Returns information of the session.
boolean	isEditOperation() Returns true for data source edit operation.

Method Detail

getSessionInfo

SessionInfo getSessionInfo()

Returns information of the session.

For more information, see SessionInfo.

Returns:

The SessionInfo object.

getDSParameters

java.util.Map getDSParameters()

Returns the Map that contains the data source parameters as supplied by the server-side/processing layer plug-in.

Returns:

The Map that contains data source parameters.

isEditOperation

boolean isEditOperation()

Returns true for data source edit operation.

The edit operation can be called when the user clicks "Edit Settings" option from the Query Panel.

Returns:

true, if the call is for data source edit; otherwise, false..

getFont

java.awt.Font getFont()

Returns the interface font that is currently in use.

The plug-in uses this font type to maintain uniformity across the UI.

Returns:

The interface font.

getDSPath

java.lang.String getDSPath()

Returns the specified data source path for plug-ins with "FILE" or "URL" resource type(The value provided by the plug-in for call to CDSExtensionDescriptor.getDSResourceType()).

It may return null or empty string for plug-ins with Resource Type as "NONE" or if the information is not available.

Returns:

the data source path.