Interface IDSSXMLElementServer


  • public interface IDSSXMLElementServer
    The ElementServer interface retrieves elements from the Intelligence Server.
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String GetElements​(java.lang.String sessionID, java.lang.String attributeID, java.lang.String attributeForms, java.lang.String browsePath, java.lang.String filter, java.lang.String resolution, int flags, int blockBegin, int blockCount)
      Gets the elements XML for an attribute.
      java.lang.String GetElementsEx​(java.lang.String sessionID, java.lang.String attributeID, java.lang.String attributeForms, java.lang.String browsePath, java.lang.String filter, java.lang.String resolution, int flags, int blockBegin, int blockCount, java.lang.String dataSourceXML)
      Gets the elements XML for an attribute.
      java.lang.String GetElementsEx​(java.lang.String sessionID, java.lang.String messageID, java.lang.String attributeID, java.lang.String attributeForms, java.lang.String browsePath, java.lang.String filter, java.lang.String resolution, int flags, int blockBegin, int blockCount, java.lang.String dataSourceXML)
      Gets the elements XML for an attribute.
      java.lang.String GetHierarchy​(java.lang.String sessionID, java.lang.String dimensionID, java.lang.String attributeID, java.lang.String browsePath, int flags, int level, int blockCount)
      Returns a hierarchy in the metadata in XML.
    • Field Detail

      • DEFAULT_GetElements_attributeForms

        static final java.lang.String DEFAULT_GetElements_attributeForms
        Default attributeForms parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_browsePath

        static final java.lang.String DEFAULT_GetElements_browsePath
        Default browsePath parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_filter

        static final java.lang.String DEFAULT_GetElements_filter
        Default filter parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_resolution

        static final java.lang.String DEFAULT_GetElements_resolution
        Default resolution parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_flags

        static final int DEFAULT_GetElements_flags
        Default flags parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_blockBegin

        static final int DEFAULT_GetElements_blockBegin
        Default blockBegin parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetElements_blockCount

        static final int DEFAULT_GetElements_blockCount
        Default blockCount parameter for GetElements method
        See Also:
        Constant Field Values
      • DEFAULT_GetHierarchy_attributeID

        static final java.lang.String DEFAULT_GetHierarchy_attributeID
        Default attributeID parameter for GetHierarchy method
        See Also:
        Constant Field Values
      • DEFAULT_GetHierarchy_browsePath

        static final java.lang.String DEFAULT_GetHierarchy_browsePath
        Default browsePath parameter for GetHierarchy method
        See Also:
        Constant Field Values
      • DEFAULT_GetHierarchy_flags

        static final int DEFAULT_GetHierarchy_flags
        Default flags parameter for GetHierarchy method
        See Also:
        Constant Field Values
      • DEFAULT_GetHierarchy_level

        static final int DEFAULT_GetHierarchy_level
        Default level parameter for GetHierarchy method
        See Also:
        Constant Field Values
      • DEFAULT_GetHierarchy_blockCount

        static final int DEFAULT_GetHierarchy_blockCount
        Default blockCount parameter for GetHierarchy method
        See Also:
        Constant Field Values
    • Method Detail

      • GetElements

        java.lang.String GetElements​(java.lang.String sessionID,
                                     java.lang.String attributeID,
                                     java.lang.String attributeForms,
                                     java.lang.String browsePath,
                                     java.lang.String filter,
                                     java.lang.String resolution,
                                     int flags,
                                     int blockBegin,
                                     int blockCount)
                              throws MSTRWebAPIException
        Gets the elements XML for an attribute.
        Parameters:
        sessionID - A valid Session ID
        attributeID - The attribute for which to retrieve elements.
        attributeForms - The collection of forms. [default=""]
        browsePath - The path browsed to get here. [default=""]
        filter - Filter to apply to browse action. [default=""]
        resolution - Used for any prompts in the filter. [default=""]
        flags - Reserved [default=0]
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException - Signals an error condition.
      • GetHierarchy

        java.lang.String GetHierarchy​(java.lang.String sessionID,
                                      java.lang.String dimensionID,
                                      java.lang.String attributeID,
                                      java.lang.String browsePath,
                                      int flags,
                                      int level,
                                      int blockCount)
                               throws MSTRWebAPIException
        Returns a hierarchy in the metadata in XML.
        Parameters:
        sessionID - A valid Session ID.
        dimensionID - The dimension that defines the hierarchy.
        attributeID - Starting place in hierarchy (if not at top). [Default=""]
        browsePath - The path browsed to get here. [Default=""]
        flags - Reserved. [Default=0]
        level - 0 = infinite, 1 = 1 level, etc. Not yet implemented in MicroStrategy 7.1. [Default=0]
        blockCount - Maximum number of elements to return. [Default=-1]
        Returns:
        java.lang.String
        Throws:
        MSTRWebAPIException - Signals an error condition.
      • GetElementsEx

        java.lang.String GetElementsEx​(java.lang.String sessionID,
                                       java.lang.String attributeID,
                                       java.lang.String attributeForms,
                                       java.lang.String browsePath,
                                       java.lang.String filter,
                                       java.lang.String resolution,
                                       int flags,
                                       int blockBegin,
                                       int blockCount,
                                       java.lang.String dataSourceXML)
                                throws MSTRWebAPIException
        Gets the elements XML for an attribute.
        Parameters:
        sessionID - A valid Session ID
        attributeID - The attribute for which to retrieve elements.
        attributeForms - The collection of forms. [default=""]
        browsePath - The path browsed to get here. [default=""]
        filter - Filter to apply to browse action. [default=""]
        resolution - Used for any prompts in the filter. [default=""]
        flags - Reserved [default=0]
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        dataSourceXML - If the element browse request uses a data source other than the warehouse, this parameter should contain an XML string containing those data sources.
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0
      • GetElementsEx

        java.lang.String GetElementsEx​(java.lang.String sessionID,
                                       java.lang.String messageID,
                                       java.lang.String attributeID,
                                       java.lang.String attributeForms,
                                       java.lang.String browsePath,
                                       java.lang.String filter,
                                       java.lang.String resolution,
                                       int flags,
                                       int blockBegin,
                                       int blockCount,
                                       java.lang.String dataSourceXML)
                                throws MSTRWebAPIException
        Gets the elements XML for an attribute.
        Parameters:
        sessionID - A valid Session ID
        messageID - A valid Message ID
        attributeID - The attribute for which to retrieve elements.
        attributeForms - The collection of forms. [default=""]
        browsePath - The path browsed to get here. [default=""]
        filter - Filter to apply to browse action. [default=""]
        resolution - Used for any prompts in the filter. [default=""]
        flags - Reserved [default=0]
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        dataSourceXML - If the element browse request uses a data source other than the warehouse, this parameter should contain an XML string containing those data sources.
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0