Package com.microstrategy.webapi

Interface IDSSXMLMDXCubeServer

  • public interface IDSSXMLMDXCubeServer
    This interface contains methods relating to cube and cube object browsing.
    Since:
    MicroStrategy Web 8.0.2

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String AlterMDXCube​(java.lang.String sessionID, java.lang.String tableID, java.lang.String catalogName, java.lang.String technicalName)
      Alters an MDX cube definition
      java.lang.String FindMDXObject​(java.lang.String sessionID, java.lang.String dataSourcesXML, java.lang.String extendableParameter, java.lang.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.
      java.lang.String GetMDXCubeObjects​(java.lang.String sessionID, int level, int blockBegin, int blockCount, int flags, java.lang.String extendableParameter, java.lang.String cubeID, java.lang.String dimensionID, java.lang.String hierarchyID)
      This method accomplishes cube object browsing.
      java.lang.String GetMDXCubes​(java.lang.String sessionID, int level, int blockBegin, int blockCount, int flags, java.lang.String extendableParameter, java.lang.String dbRoleID, java.lang.String catalogName)
      This method accomplishes cube browsing.

    • Method Detail

      • GetMDXCubes

        java.lang.String GetMDXCubes​(java.lang.String sessionID,
                             int level,
                             int blockBegin,
                             int blockCount,
                             int flags,
                             java.lang.String extendableParameter,
                             java.lang.String dbRoleID,
                             java.lang.String catalogName)
                      throws MSTRWebAPIException
        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.

      • GetMDXCubeObjects

        java.lang.String GetMDXCubeObjects​(java.lang.String sessionID,
                                   int level,
                                   int blockBegin,
                                   int blockCount,
                                   int flags,
                                   java.lang.String extendableParameter,
                                   java.lang.String cubeID,
                                   java.lang.String dimensionID,
                                   java.lang.String hierarchyID)
                            throws MSTRWebAPIException
        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.

      • FindMDXObject

        java.lang.String FindMDXObject​(java.lang.String sessionID,
                               java.lang.String dataSourcesXML,
                               java.lang.String extendableParameter,
                               java.lang.String objectID,
                               int type,
                               int flags,
                               int level,
                               int blockBegin,
                               int blockCount)
                        throws MSTRWebAPIException
        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.
        level - Unused.
        flags - The flags value.
        blockBegin - The blockBegin value, used for incremental fetch.
        blockCount - The blockCount value, used for incremental fetch.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • AlterMDXCube

        java.lang.String AlterMDXCube​(java.lang.String sessionID,
                              java.lang.String tableID,
                              java.lang.String catalogName,
                              java.lang.String technicalName)
                       throws MSTRWebAPIException
        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.