A C D E F G H I M N O P R S T U V W

A

AbstractCustomDataProvider - Class in com.businessobjects.customds
AbstractCustomDataProvider is an abstract implementation class for CustomDataProvider.
AbstractCustomDataProvider() - Constructor for class com.businessobjects.customds.AbstractCustomDataProvider
 
AbstractCustomDataSource - Class in com.businessobjects.customds
AbstractCustomDataSource is an abstract implementation class for CustomDataSource.
AbstractCustomDataSource() - Constructor for class com.businessobjects.customds.AbstractCustomDataSource
 
AbstractCustomDSComponent - Class in com.businessobjects.customds.ui
AbstractCustomDSComponent is an abstract implementation class for CustomDSComponent.
AbstractCustomDSComponent() - Constructor for class com.businessobjects.customds.ui.AbstractCustomDSComponent
 
AbstractCustomDSExtension - Class in com.businessobjects.customds.ui
AbstractCustomDSComponent is an abstract implementation class for CustomDSExtension.
AbstractCustomDSExtension() - Constructor for class com.businessobjects.customds.ui.AbstractCustomDSExtension
 
addColumn(ColumnSpec) - Method in class com.businessobjects.customds.common.ColumnsInfo
Adds the ColumnSpec to the ColumnsInfo object.
addColumns(Collection) - Method in class com.businessobjects.customds.common.ColumnsInfo
Adds the collection of ColumnSpec(s) to the ColumnsInfo object.
addDate(Date, int) - Method in class com.businessobjects.customds.common.Row
Adds the specified date to the row object at the specified column index.
addNumber(Number, int) - Method in class com.businessobjects.customds.common.Row
Adds the specified number to the row object at the specified column index.
addRow(Row) - Method in class com.businessobjects.customds.common.Chunk
Adds a row of columnar data to the Chunk object.
addRows(Collection) - Method in class com.businessobjects.customds.common.Chunk
Adds rows of columnar data to the Chunk object.
addString(String, int) - Method in class com.businessobjects.customds.common.Row
Adds the specified string value to the Row object at the specified column index.

C

cancel(int) - Method in class com.businessobjects.customds.AbstractCustomDataProvider
Default empty implementation.
cancel(int) - Method in interface com.businessobjects.customds.CustomDataProvider
Notifies the plug-in to cancel any operation on the Data Iterator identified by the ID sent while calling the openIterator(IteratorInfo, ColumnSpec[]) method.
CDSExtensionBaseDescriptor - Interface in com.sap.customds.framework.common
The CDSExtensionBaseDescriptor interface is used to get the basic details of Custom Data Source Framework(CDS Framework) plug-in.
CDSExtensionDescriptor - Interface in com.sap.customds.framework.common
The CDSExtensionDescriptor interface is used to get the details of Custom Data Source Framework(CDS Framework) user interface plug-in.
CDSExtensionException - Exception in com.businessobjects.customds.ui.exception
CDSExtensionException is an exception class that the plug-in uses for all handled exceptions, to enable the Framework to display localized messages to the user and append exception messages in the Framework's or product's log.
CDSExtensionException(String, String) - Constructor for exception com.businessobjects.customds.ui.exception.CDSExtensionException
Class Constructor
CDSExtensionException(Throwable, String, String) - Constructor for exception com.businessobjects.customds.ui.exception.CDSExtensionException
Class Constructor
CDSExtensionResourceType - Class in com.sap.customds.framework.common
The CDSExtensionResourceType enum defines the possible resource-types for the Custom Data Source Framework(CDS Framework) user interface plug-in.
Chunk - Class in com.businessobjects.customds.common
The Chunk class contains the data provided by the plug-in.
Chunk(ColumnSpec[]) - Constructor for class com.businessobjects.customds.common.Chunk
The Chunk class constructor creates data chunks with specified column information.
clean() - Method in class com.businessobjects.customds.AbstractCustomDataSource
Default empty implementation.
clean() - Method in interface com.businessobjects.customds.CustomDataSource
Notifies the plug-in to perform required clean-up activities.
clean() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Default empty implementation.
clean() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Notifies the plug-in to do any clean-up activity.
clear() - Method in class com.businessobjects.customds.common.Chunk
Clears all the rows added to the Chunk object.
clear() - Method in class com.businessobjects.customds.common.ColumnsInfo
Clears all the ColumnSpec(s) from the ColumnsInfo object.
ClientType - Class in com.businessobjects.customds.ui.common
The ClientType enum defines the type of client where the plug-in is used.
closeIterator(int) - Method in class com.businessobjects.customds.AbstractCustomDataProvider
Removes the IteratorInfo object with the specified iterator ID from the iterator collection.
closeIterator(int) - Method in interface com.businessobjects.customds.CustomDataProvider
Notifies the plug-in that the Data Iterator identified by the ID sent while calling openIterator(IteratorInfo, ColumnSpec[]) method is closed.
ColumnsInfo - Class in com.businessobjects.customds.common
The ColumnsInfo class contains all the ColumnSpec that form the objects (columns) of the data provider.
ColumnsInfo() - Constructor for class com.businessobjects.customds.common.ColumnsInfo
Class Constructor
ColumnSpec - Class in com.businessobjects.customds.common
The ColumnSpec class is used to identify details such as name and data type of the data provider object (column) used in the data provider.
ColumnSpec() - Constructor for class com.businessobjects.customds.common.ColumnSpec
Class Constructor - When using this constructor, by default, the column name will be an empty string and type ObjectTypes.STRING.
ColumnSpec(String) - Constructor for class com.businessobjects.customds.common.ColumnSpec
Class Constructor - Defaults object (column) data type to ObjectTypes.STRING.
ColumnSpec(String, int) - Constructor for class com.businessobjects.customds.common.ColumnSpec
Class Constructor
com.businessobjects.customds - package com.businessobjects.customds
The plug-in implements the interfaces in the com.businessobjects.customds package to provide the required information by the Interactive Analysis CDS Framework to access the data source and to fetch data for the data provider.
com.businessobjects.customds.common - package com.businessobjects.customds.common
The Framework and the plug-in uses the classes in the com.businessobjects.customds.common package to access the data source, build data providers, and fetch data for Interactive Analysis.
com.businessobjects.customds.exception - package com.businessobjects.customds.exception
The Framework and the plug-in uses the classes in the com.businessobjects.customds.exception package to create Exception objects.
com.businessobjects.customds.ui - package com.businessobjects.customds.ui
The plug-in implements the interfaces in the com.businessobjects.customds.ui package to provide the user interface based on the input received from the data provider source plug-in.
com.businessobjects.customds.ui.common - package com.businessobjects.customds.ui.common
The plug-in uses the interfaces in the com.businessobjects.customds.ui.common package to retrieve information that is required to build the user interface.
com.businessobjects.customds.ui.exception - package com.businessobjects.customds.ui.exception
The plug-in uses the classes in the com.businessobjects.customds.ui.exception package to create Exception objects.
com.sap.customds.framework.common - package com.sap.customds.framework.common
The plug-in implements the interfaces in the com.sap.customds.framework.common package to provide the required information by the Interactive Analysis CDS Framework to register the plug-in.
CustomDataProvider - Interface in com.businessobjects.customds
The CustomDataProvider interface is used to retrieve data from the plug-in (extension of CDS Framework) for the data provider.
CustomDataSource - Interface in com.businessobjects.customds
The CustomDataSource interface is the Interactive Analysis Server/Processing layer extension point of the Custom Data Source Framework(CDS Framework).
CustomDataSourceInfo - Interface in com.businessobjects.customds.common
The CustomDataSourceInfo interface is used to return the basic information required by the plug-in (extension) for accessing the data source.
CustomDataSourceParamIds - Interface in com.businessobjects.customds.common
The CustomDataSourceParamIds interface defines the set of pre-defined data source parameters used by the Framework.
CustomDSComponent - Interface in com.businessobjects.customds.ui
The CustomDSComponent is a helper interface that provides user interface component to the Framework.
CustomDSExtension - Interface in com.businessobjects.customds.ui
The CustomDSExtension interface is the Interactive Analysis Client / User Interface extension point.

D

DataHolder - Interface in com.businessobjects.customds.ui.common
The DataHolder interface is used to obtain data that is useful in creating the user interface.
DataSourceException - Exception in com.businessobjects.customds.exception
DataSourceException is an exception class that the framework and plug-in use for all the handled exceptions.
DataSourceException(String, int, int) - Constructor for exception com.businessobjects.customds.exception.DataSourceException
Class Constructor
DataSourceException(Throwable, String, int, int) - Constructor for exception com.businessobjects.customds.exception.DataSourceException
Class Constructor
DATE - Static variable in interface com.businessobjects.customds.common.ObjectTypes
Represents the java.util.Date data type.
DeploymentContext - Class in com.businessobjects.customds.common
DeploymentContext class is used to define the current deployment context type.
DESKTOP - Static variable in class com.businessobjects.customds.common.DeploymentContext
Desktop context type.
DESKTOP - Static variable in class com.businessobjects.customds.ui.common.ClientType
Interactive Analysis Desktop Client.
DS_CONNECT_STRING - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.connect"
DS_EDIT_PARAMS - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.ds_edit_params"
DS_EXTN_NAME - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.dsextnname"
DS_EXTN_RESOURCETYPE_IS_RESOURCE_BASED - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.is_resource_based"
DS_EXTN_RESOURCETYPE_IS_URL - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.is_file_path_url"
DS_EXTN_SUBTYPE - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.dssubtype"
DS_EXTN_VER - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.dsextnver"
DS_FILE_PATH - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.file_path"
DS_REF_ID - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.dsrefid"
DS_SOURCE_CHANGED - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.cds.source_changed"
DS_SUBTYPE - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.subtype"
DS_SUBTYPE_CLSID - Static variable in interface com.businessobjects.customds.common.CustomDataSourceParamIds
Internal Use Only Internal Data Source Parameter Key - "ds.custom.params.daext_clsid"

E

ENTERPRISE - Static variable in class com.businessobjects.customds.common.DeploymentContext
Enterprise context type.
equals(Object) - Method in class com.businessobjects.customds.common.ColumnSpec
Internal Use Only
ErrorCodes - Interface in com.businessobjects.customds.common
The ErrorCodes interface defines the error codes used for creating the DataSourceException.

F

FILE - Static variable in class com.sap.customds.framework.common.CDSExtensionResourceType
Plug-ins that supports "FILE" based data sources.
free() - Method in class com.businessobjects.customds.ui.AbstractCustomDSComponent
Default empty implementation.
free() - Method in interface com.businessobjects.customds.ui.CustomDSComponent
Notifies the plug-in to do any clean-up activities for the user interface component.
fromType(int) - Static method in class com.businessobjects.customds.common.DeploymentContext
Returns a DeploymentContext instance corresponding to its int description.

G

getActionTitle() - Method in class com.businessobjects.customds.ui.AbstractCustomDSComponent
Returns empty String.
getActionTitle() - Method in interface com.businessobjects.customds.ui.CustomDSComponent
Implementation of this method must return the localized String of the current action that user is expected to perform on the user interface component.
getCause() - Method in exception com.businessobjects.customds.exception.DataSourceException
Returns the cause of the DataSourceException or null, if the cause is unknown.
getCause() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Returns the cause of CDSExtensionException or null, if the cause is unknown.
getCDSComponent(DataHolder) - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the instance that can provide the plug-in's user interface component.
getCESessionID() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the CE session ID of the Interactive Analysis Client.
getChunkData() - Method in class com.businessobjects.customds.common.Chunk
Internal Use Only
getChunkSize() - Method in class com.businessobjects.customds.AbstractCustomDataSource
Returns the default chunk size.
getChunkSize() - Method in interface com.businessobjects.customds.CustomDataSource
Implementation of this method must return the size of each Chunk that must be returned by the plug-in's CustomDataProvider implementation.
getClientName() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the name of the Interactive Analysis client used for invoking the current workflow.
getClientType() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns type of client where the plug-in is used with the current deployment.
getColumnName() - Method in class com.businessobjects.customds.common.ColumnSpec
Returns the name of the object (column).
getColumnsInfo() - Method in class com.businessobjects.customds.common.ColumnsInfo
Internal Use Only
getColumnsInfo(Map) - Method in interface com.businessobjects.customds.CustomDataSource
Implementation of this method must return the details of the object(s) (column(s)) used to build the data provider.
getColumnSpec(int) - Method in class com.businessobjects.customds.common.ColumnsInfo
Returns the ColumnSpec object at the specified index in the ColumnsInfo object.
getColumnSpec(String) - Method in class com.businessobjects.customds.common.ColumnsInfo
Returns an array of ColumnSpec objects with the specified name.
getColumnSpecs() - Method in class com.businessobjects.customds.common.Chunk
Internal Use Only
getColumnType() - Method in class com.businessobjects.customds.common.ColumnSpec
Returns the data type of the object (column).
getCustomDataProvider(ColumnSpec[]) - Method in interface com.businessobjects.customds.CustomDataSource
Implementation of this method must return an object for the data provider of the plug-in.
getDataProviderIcon() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getDataProviderIcon() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in's data provider image icon, if any.
getDataSourceDescription() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getDataSourceDescription() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the description of the data source supported by the plug-in.
getDataSourceType() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the data source type of the plug-in (extension).
getDataSourceType() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the data source type of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getDataSourceType().
getDataSourceType() - Method in interface com.sap.customds.framework.common.CDSExtensionBaseDescriptor
Implementation of this method must return the data source type of the plug-in.
getDeploymentContext() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the deployment context for the current workflow.
getDisplayMessage() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Internal Use Only
getDisplayName() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getDisplayName() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the display name of the plug-in.
getDSDefaultLocations() - Method in interface com.sap.customds.framework.common.CDSExtensionDescriptor
Implementation of this method must return the supported data source default locations for the plug-in with resource-type as "FILE"(CDSExtensionResourceType.FILE) or "URL" (CDSExtensionResourceType.URL).
getDSFileExtension() - Method in interface com.sap.customds.framework.common.CDSExtensionDescriptor
Implementation of this method must return the supported data source file extension(s) for the plug-in with resource-type as "FILE"(CDSExtensionResourceType.FILE).
getDSParameters(Map) - Method in class com.businessobjects.customds.AbstractCustomDataSource
Returns null.
getDSParameters(Map) - Method in interface com.businessobjects.customds.CustomDataSource
Implementation of this method must return additional set of data source parameters, if any, in the form of key (String(non-null))- value (String) pairs.
getDSParameters() - Method in interface com.businessobjects.customds.ui.common.DataHolder
Returns the Map that contains the data source parameters as supplied by the server-side/processing layer plug-in.
getDSPath() - Method in interface com.businessobjects.customds.ui.common.DataHolder
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()).
getDSResourceType() - Method in interface com.sap.customds.framework.common.CDSExtensionDescriptor
Implementation of this method must return the data source resource-type supported by the plug-in.
getException() - Method in exception com.businessobjects.customds.exception.DataSourceException
Returns the DataSourceException as a Throwable object.
getException() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Returns the CDSExtensionException as a Throwable object.
getExcludedRowCount() - Method in class com.businessobjects.customds.common.IteratorInfo
Returns the excluded row count associated with the Data Iterator object set by the plug-in.
getExtensionBaseDescriptor() - Method in interface com.businessobjects.customds.CustomDataSource
Invoked by the Framework after the instantiation of the plug-in through default constructor to know the plug-in details.
getExtensionDescriptor() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Invoked by the Framework after the instantiation of the plug-in through default constructor.
getExtensionName() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the extension name of the plug-in (extension).
getExtensionName() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the extension name of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getName().
getExtensionVersion() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the extension version of the plug-in (extension).
getExtensionVersion() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the extension version of the plug-in (extension) as provided by CDSExtensionBaseDescriptor.getVersion().
getFileExtnDescription() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getFileExtnDescription() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the description of file extensions of the supported files, if any.
getFont() - Method in interface com.businessobjects.customds.ui.common.DataHolder
Returns the interface font that is currently in use.
getHelpURL() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getHelpURL(String, String) - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getHelpURL() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in Help URL.
getHelpURL(String, String) - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in Help URL.
getImageIcon() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getImageIcon() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in's data source image icon, if any.
getInterfaceLocale() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the interface locale of the Interactive Analysis Client.
getInterfaceLocale() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the user interface locale as provided by the Framework.
getIteratorId() - Method in class com.businessobjects.customds.common.IteratorInfo
Returns the unique ID of the Data Iterator.
getMajorCode() - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
getMessage(boolean) - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
getMessage() - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
getMessage(boolean) - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Internal Use Only
getMessage() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Internal Use Only
getMinorCode() - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
getName() - Method in class com.businessobjects.customds.ui.common.ClientType
Returns the name of the ClientType enum.
getName() - Method in interface com.sap.customds.framework.common.CDSExtensionBaseDescriptor
Implementation of this method must return the name of the plug-in.
getName() - Method in class com.sap.customds.framework.common.CDSExtensionResourceType
Returns the name of the CDSExtensionResourceType enum.
getNewActionText() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns empty String.
getNewActionText() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in's new data provider action text, if any.
getNewActionTooltip() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns empty String.
getNewActionTooltip() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in's new data provider action tool-tip, if any.
getNewDataProviderIcon() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns null.
getNewDataProviderIcon() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must return the plug-in's data provider creation image icon, if any.
getNextChunk(int, ColumnSpec[]) - Method in interface com.businessobjects.customds.CustomDataProvider
Implementation of this method must return next Chunk of data.
getProductClassesDir() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Deprecated. since 14.0, use the path provided by method SessionInfo.getSharedClassesDir() instead.
getProductHelpPath() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the root help path of the SAP BusinessObjects installation.
getRowCount() - Method in class com.businessobjects.customds.common.IteratorInfo
Returns the row count associated with the Data Iterator object set by the plug-in.
getRowValues() - Method in class com.businessobjects.customds.common.Row
Internal Use Only
getServerPath() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the physical storage path of the Data Source on the Interactive Analysis Server machine.
getSessionID() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the current user session ID generated during login.
getSessionInfo() - Method in interface com.businessobjects.customds.ui.common.DataHolder
Returns information of the session.
getSharedClassesDir() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the location of the SAP BusinessObjects install shared classes directory.
getSharedClassesDir() - Method in interface com.businessobjects.customds.ui.common.SessionInfo
Returns the location of the SAP BusinessObjects install shared classes directory.
getSource() - Method in interface com.businessobjects.customds.common.CustomDataSourceInfo
Returns the source (file path / URL), if any, as provided by the user; otherwise empty string.
getStackTraceAsString() - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
getStackTraceAsString() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Internal Use Only
getUIComponent() - Method in interface com.businessobjects.customds.ui.CustomDSComponent
Implementation of this method must return the plug-in's user interface component.
getUpdatedDSParams() - Method in interface com.businessobjects.customds.ui.CustomDSComponent
Implementation of this method must return the updated data source parameters from the plug-in.
getValue() - Method in class com.businessobjects.customds.common.DeploymentContext
Returns the int value corresponding to the deployment context type.
getValue() - Method in class com.businessobjects.customds.ui.common.ClientType
Returns the int value of the ClientType enum.
getValue() - Method in class com.sap.customds.framework.common.CDSExtensionResourceType
Returns the int value of the CDSExtensionResourceType enum.
getVersion() - Method in interface com.sap.customds.framework.common.CDSExtensionBaseDescriptor
Implementation of this method must return the version of the plug-in.

H

hashCode() - Method in class com.businessobjects.customds.common.ColumnSpec
Internal Use Only
hasNextChunk(int) - Method in interface com.businessobjects.customds.CustomDataProvider
Checks if the plug-in has more chunks to return.

I

init(CustomDataSourceInfo) - Method in class com.businessobjects.customds.AbstractCustomDataSource
Stores the complete CustomDataSourceInfo information.
init(CustomDataSourceInfo) - Method in interface com.businessobjects.customds.CustomDataSource
Invoked by the Framework after the call to CustomDataSource.getExtensionBaseDescriptor(), to enable the plug-in to initialize itself.
init(SessionInfo) - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Stores the complete SessionInfo information.
init(SessionInfo) - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Invoked by the Framework after the call to CustomDSExtension.getExtensionDescriptor(), to enable the plug-in initialize itself for use by the Framework.
isDataSourceParamsComplete(Map) - Method in class com.businessobjects.customds.AbstractCustomDataSource
Returns true.
isDataSourceParamsComplete(Map) - Method in interface com.businessobjects.customds.CustomDataSource
Implementation of this method must return true if the plug-in is ready to access the data source with the given set of user inputs.
isEditOperation() - Method in interface com.businessobjects.customds.ui.common.DataHolder
Returns true for data source edit operation.
isExtensionHelpAvailable() - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Returns false.
isExtensionHelpAvailable() - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Invoked by the Framework to check if the Framework must display plug-in specific help files or product help files.
isRowCountBased - Variable in class com.businessobjects.customds.common.IteratorInfo
The isRowCountBased boolean is used to check if the row count set for this Iterator is accurate.
IteratorInfo - Class in com.businessobjects.customds.common
The IteratorInfo class contains information about the data iterator.
IteratorInfo(int) - Constructor for class com.businessobjects.customds.common.IteratorInfo
Class Constructor - Internal Use Only

M

MAJOR_CUSTOM_DSP_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Internal Use Only Unable to create/update CustomDataProvider: A problem was encountered in Data Source extension management and the requested action cannot be completed.
MAJOR_DATA_ITERATOR_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: unable to build the iterator on the data set.
MAJOR_GET_INFO_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: unable to retrieve information from the provided source.
MAJOR_GET_STRUCTURE_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: unable to retrieve structure information from the provided source.
MAJOR_INSTANTIATION_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Internal Use Only Unable to create/update the CustomDataProvider: Unable to instantiate the plug-in data source (CDS 105101)
MAJOR_SESSION_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: A problem was encountered while trying to get the session and the requested action cannot be completed.
MINOR_COLUMN_SAMPLING_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: an error has occurred while retrieving the data sampling.
MINOR_CUSTOM - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Specified while creating the DataSourceException object if the plug-in wants to propagate its own error message to the client.
MINOR_CUSTOM_DSP_EXTENSION_DP_NOT_INSTANTIATED - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Internal Use Only Unable to create/update CustomDataProvider: could not instantiate Data Source extension's Data Provider for this request.
MINOR_CUSTOM_DSP_EXTENSION_NOT_FOUND - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Internal Use Only Unable to create/update CustomDataProvider: could not find matching Data Source extension for this request.
MINOR_CUSTOM_DSP_EXTENSION_NOT_INSTANTIATED - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Internal Use Only Unable to create/update CustomDataProvider: could not instantiate matching Data Source extension for this request.
MINOR_FILE_MISSING - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update the query on this file : the file "{filename}" doesn't exist on the file system.
MINOR_GENERIC - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Specified while creating the DataSourceException object to propagate the pre-defined error messages of the major codes to the client.
MINOR_GET_CHUNK_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to retrieve data from CustomDataProvider: an error has occurred while fetching data through the iterator.
MINOR_INVALID_DATA_SOURCE_INFO - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: invalid information retrieved while trying to get the structure.
MINOR_INVALID_FILE_PATH - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: the path is invalid.
MINOR_ITERATOR_INIT_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to retrieve data from CustomDataProvider: an error has occurred while creating the data iterator.
MINOR_MALFORMED_URL_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: the provided URL is not valid.
MINOR_OBJECT_DESCRIPTOR_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: unsupported object type provided by the Data Source extension while trying to get the structure.
MINOR_OPEN_SESSION_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: an internal error occurred while trying to open the session.
MINOR_SECURED_FILE_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: the source in the provided path is protected.
MINOR_URL_NOT_FOUND_ERROR - Static variable in interface com.businessobjects.customds.common.ErrorCodes
Unable to create/update CustomDataProvider: the provided URL could not be found.

N

NONE - Static variable in class com.sap.customds.framework.common.CDSExtensionResourceType
Plug-ins that supports use of data sources that is neither a "FILE" or "URL", example memory structures.
NUMBER - Static variable in interface com.businessobjects.customds.common.ObjectTypes
Represents the java.util.Number data type.

O

ObjectTypes - Interface in com.businessobjects.customds.common
The ObjectTypes interface defines the set of supported data types.
openIterator(IteratorInfo, ColumnSpec[]) - Method in class com.businessobjects.customds.AbstractCustomDataProvider
Stores the complete IteratorInfo information in the iterator collection.
openIterator(IteratorInfo, ColumnSpec[]) - Method in interface com.businessobjects.customds.CustomDataProvider
Invoked by the Framework to provide and retrieve some of the details of IteratorInfo.

P

processMissingDSParams(Map) - Method in interface com.businessobjects.customds.ui.CustomDSComponent
Invoked by the Framework to enable the plug-in process missing / new set of data source parameters.

R

requiresExtensionDialog() - Method in interface com.sap.customds.framework.common.CDSExtensionDescriptor
Implementation of this method must return true if plug-in requires user interaction apart from data source details, if any.
RIA - Static variable in class com.businessobjects.customds.ui.common.ClientType
Interactive Analysis RIA Client(RIA Stands for Rich Internet Application).
Row - Class in com.businessobjects.customds.common
The Row class contains the data of the data provider.
Row(int) - Constructor for class com.businessobjects.customds.common.Row
Class Constructor - The row object must be created by specifying the number of columns for which this Row object contains data.

S

SessionInfo - Interface in com.businessobjects.customds.ui.common
The SessionInfo interface provides some of the current user session information and also a few environment details that are related to product installation.
setChunkSize(int, int) - Method in class com.businessobjects.customds.AbstractCustomDataProvider
Sets the internal data chunk size value to the value specified by chunkSize.
setChunkSize(int, int) - Method in interface com.businessobjects.customds.CustomDataProvider
Invoked by the Framework to enable the plug-in set the Chunk size.
setColumnName(String) - Method in class com.businessobjects.customds.common.ColumnSpec
Sets the name of the object (column).
setColumnType(int) - Method in class com.businessobjects.customds.common.ColumnSpec
Sets the data type of the object (column).
setExcludedRowCount(int) - Method in class com.businessobjects.customds.common.IteratorInfo
Sets the excluded row count associated with the Data Iterator object.
setLocale(Locale) - Method in class com.businessobjects.customds.ui.AbstractCustomDSExtension
Stores the provided interface Locale information.
setLocale(Locale) - Method in interface com.businessobjects.customds.ui.CustomDSExtension
Implementation of this method must set or re-set the interface locale during this method call.
setRowCount(int) - Method in class com.businessobjects.customds.common.IteratorInfo
Sets the row count for the Data Iterator.
STRING - Static variable in interface com.businessobjects.customds.common.ObjectTypes
Represents the java.util.String data type.

T

toString() - Method in exception com.businessobjects.customds.exception.DataSourceException
Internal Use Only
toString() - Method in class com.businessobjects.customds.ui.common.ClientType
Returns the String value of the ClientType enum.
toString() - Method in exception com.businessobjects.customds.ui.exception.CDSExtensionException
Internal Use Only
toString() - Method in class com.sap.customds.framework.common.CDSExtensionResourceType
Returns the String value of the CDSExtensionResourceType enum.

U

UNDEFINED - Static variable in class com.businessobjects.customds.common.DeploymentContext
Unknown deployment context type.
URL - Static variable in class com.sap.customds.framework.common.CDSExtensionResourceType
Plug-ins that supports "URL" based data sources.

V

valueOf(String) - Static method in class com.businessobjects.customds.common.DeploymentContext
 
valueOf(String) - Static method in class com.businessobjects.customds.ui.common.ClientType
 
valueOf(String) - Static method in class com.sap.customds.framework.common.CDSExtensionResourceType
 
values() - Static method in class com.businessobjects.customds.common.DeploymentContext
 
values() - Static method in class com.businessobjects.customds.ui.common.ClientType
 
values() - Static method in class com.sap.customds.framework.common.CDSExtensionResourceType
 

W

WEB - Static variable in class com.businessobjects.customds.ui.common.ClientType
Interactive Analysis Web Client.

A C D E F G H I M N O P R S T U V W