public interface

IDSSXMLElementServer

com.microstrategy.webapi.IDSSXMLElementServer

Class Overview

The ElementServer interface retrieves elements from the Intelligence Server.

Summary

Constants
String DEFAULT_GetElements_attributeForms Default attributeForms parameter for GetElements method
int DEFAULT_GetElements_blockBegin Default blockBegin parameter for GetElements method
int DEFAULT_GetElements_blockCount Default blockCount parameter for GetElements method
String DEFAULT_GetElements_browsePath Default browsePath parameter for GetElements method
String DEFAULT_GetElements_filter Default filter parameter for GetElements method
int DEFAULT_GetElements_flags Default flags parameter for GetElements method
String DEFAULT_GetElements_resolution Default resolution parameter for GetElements method
String DEFAULT_GetHierarchy_attributeID Default attributeID parameter for GetHierarchy method
int DEFAULT_GetHierarchy_blockCount Default blockCount parameter for GetHierarchy method
String DEFAULT_GetHierarchy_browsePath Default browsePath parameter for GetHierarchy method
int DEFAULT_GetHierarchy_flags Default flags parameter for GetHierarchy method
int DEFAULT_GetHierarchy_level Default level parameter for GetHierarchy method
Public Methods
abstract String GetElements(String sessionID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount)
Gets the elements XML for an attribute.
abstract String GetElementsEx(String sessionID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount, String dataSourceXML)
Gets the elements XML for an attribute.
abstract String GetElementsEx(String sessionID, String messageID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount, String dataSourceXML)
Gets the elements XML for an attribute.
abstract String GetHierarchy(String sessionID, String dimensionID, String attributeID, String browsePath, int flags, int level, int blockCount)
Returns a hierarchy in the metadata in XML.

Constants

public static final String DEFAULT_GetElements_attributeForms

Default attributeForms parameter for GetElements method

Constant Value: ""

public static final int DEFAULT_GetElements_blockBegin

Default blockBegin parameter for GetElements method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_GetElements_blockCount

Default blockCount parameter for GetElements method

Constant Value: -1 (0xffffffff)

public static final String DEFAULT_GetElements_browsePath

Default browsePath parameter for GetElements method

Constant Value: ""

public static final String DEFAULT_GetElements_filter

Default filter parameter for GetElements method

Constant Value: ""

public static final int DEFAULT_GetElements_flags

Default flags parameter for GetElements method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_GetElements_resolution

Default resolution parameter for GetElements method

Constant Value: ""

public static final String DEFAULT_GetHierarchy_attributeID

Default attributeID parameter for GetHierarchy method

Constant Value: ""

public static final int DEFAULT_GetHierarchy_blockCount

Default blockCount parameter for GetHierarchy method

Constant Value: -1 (0xffffffff)

public static final String DEFAULT_GetHierarchy_browsePath

Default browsePath parameter for GetHierarchy method

Constant Value: ""

public static final int DEFAULT_GetHierarchy_flags

Default flags parameter for GetHierarchy method

Constant Value: 0 (0x00000000)

public static final int DEFAULT_GetHierarchy_level

Default level parameter for GetHierarchy method

Constant Value: 0 (0x00000000)

Public Methods

public abstract String GetElements (String sessionID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount)

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.

public abstract String GetElementsEx (String sessionID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount, String dataSourceXML)

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.

public abstract String GetElementsEx (String sessionID, String messageID, String attributeID, String attributeForms, String browsePath, String filter, String resolution, int flags, int blockBegin, int blockCount, String dataSourceXML)

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.

public abstract String GetHierarchy (String sessionID, String dimensionID, String attributeID, String browsePath, int flags, int level, int blockCount)

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.