public interface

IDSSXMLMDXCubeServer

com.microstrategy.webapi.IDSSXMLMDXCubeServer

Class Overview

This interface contains methods relating to cube and cube object browsing.

Summary

Public Methods
abstract String AlterMDXCube(String sessionID, String tableID, String catalogName, String technicalName)
Alters an MDX cube definition
abstract String FindMDXObject(String sessionID, String dataSourcesXML, String extendableParameter, String objectID, int type, int flags, int level, int blockBegin, int blockCount)
This method accomplishes finding the definition of an object in the context of one or more MDX tables/cubes.
abstract String GetMDXCubeObjects(String sessionID, int level, int blockBegin, int blockCount, int flags, String extendableParameter, String cubeID, String dimensionID, String hierarchyID)
This method accomplishes cube object browsing.
abstract String GetMDXCubes(String sessionID, int level, int blockBegin, int blockCount, int flags, String extendableParameter, String dbRoleID, String catalogName)
This method accomplishes cube browsing.

Public Methods

public abstract String AlterMDXCube (String sessionID, String tableID, String catalogName, String technicalName)

Alters an MDX cube definition

Parameters
sessionID A valid session ID.
tableID The table ID
catalogName The name of the catalog
technicalName The technical name
Returns
  • An XML string describing the results of the action
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String FindMDXObject (String sessionID, String dataSourcesXML, String extendableParameter, String objectID, int type, int flags, int level, int blockBegin, int blockCount)

This method accomplishes finding the definition of an object in the context of one or more MDX tables/cubes.

Parameters
sessionID A valid session ID.
dataSourcesXML An XML describing the data sources that are being used.
extendableParameter Parameter used to pass additional information about the call.
objectID The ID of the object being browsed.
flags The flags value.
level Unused.
blockBegin The blockBegin value, used for incremental fetch.
blockCount The blockCount value, used for incremental fetch.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetMDXCubeObjects (String sessionID, int level, int blockBegin, int blockCount, int flags, String extendableParameter, String cubeID, String dimensionID, String hierarchyID)

This method accomplishes cube object browsing.

Parameters
sessionID A valid session ID.
level The level of objects to browse.
blockBegin First object returned for incremental fetch.
blockCount The number of objects to return at a time for incremental fetch.
flags Reserved.
extendableParameter Reserved
cubeID The ID of the table of the cube to browse.
dimensionID The ID of the dimension to browse. Note that the null GUID (00000000000000000000000000000000) represents the metrics dimension.
hierarchyID The ID of the hierarchy to browse.
Returns
  • An XML string describing the results of the browse request.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetMDXCubes (String sessionID, int level, int blockBegin, int blockCount, int flags, String extendableParameter, String dbRoleID, String catalogName)

This method accomplishes cube browsing.

Parameters
sessionID A valid session ID.
level The level of objects to browse.
blockBegin First object returned for incremental fetch.
blockCount The number of objects to return at a time for incremental fetch.
flags Reserved.
extendableParameter Reserved
dbRoleID The ID of the DB role to browse. If this is passed, only that role will be returned in the XML.
catalogName The name of the catalog to browse. If this is passed, then the cubes belonging to this catalog will be returned.
Returns
  • An XML string describing the results of the browse request.
Throws
MSTRWebAPIException Thrown if an error occurs.