public class

MWSAttributeElementBrowser

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.MWSAttributeElementBrowser

Class Overview

Provides MSTR Web Service Attribute Element Browsing functionality. Elements are retrieved incrementally from specified attributes based on specified filter conditions. Drilling capability is also provided.

Summary

Public Constructors
MWSAttributeElementBrowser()
Constructor
Public Methods
MWSElementBrowseInfo DrillPromptElement(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions.
MWSElementBrowseInfo GetAttributeElements(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)
Retrieves elements from the specified attribute based on specified element filter restrictions.
MWSElementBrowseInfo GetPromptElements(MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)
Retrieves elements from the specified attribute based on specified element filter restrictions.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSAttributeElementBrowser ()

Constructor

Public Methods

public MWSElementBrowseInfo DrillPromptElement (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, ArrayOfMWSHierarchyElementFilter fromElementFilters, MWSHierarchyAttributeInfo toAttributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieve elements from the specified attribute that are ancestors/descendants of the specified element based on specified element filter restrictions. Elements can be retrieved incrementally. The element source is retrieved from the prompt using the designated attribute.

Parameters
cInfo Session connection information
oSpec Report Specification information
promptKey Prompt Identifier
fromElementFilters Identifies the element(s) to drill from.
toAttributeInfo Identifies the attribute to get drill to.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
MWSException
MWSException

public MWSElementBrowseInfo GetAttributeElements (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount)

Retrieves elements from the specified attribute based on specified element filter restrictions. Elements can be retrieved incrementally.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
Returns
  • Structure containing an element array and other status info.
Throws
MWSException

public MWSElementBrowseInfo GetPromptElements (MWSConnectInfo cInfo, MWSExecutionObjSpec oSpec, String promptKey, MWSHierarchyAttributeInfo attributeInfo, ArrayOfMWSElementRestriction arrayRestrictions, EnumMWSElementSourceFlags eFlags, int iBlockBegin, int iBlockCount, String dataSourcesXML)

Retrieves elements from the specified attribute based on specified element filter restrictions. Elements can be retrieved incrementally. Element source is the attribute found in the prompt. If the prompt describes a dimension, the attributeInfo parameter describes which attribute in the dimension to use.

Parameters
cInfo Session connection information
oSpec Object Specification information
promptKey Prompt Identifier
attributeInfo Identifies the attribute to get elements from.
arrayRestrictions Specifies element filter conditions.
eFlags Specifies element search flags.
iBlockBegin Specifies the starting element.
iBlockCount Specifies number of elements to return.
dataSourcesXML Specifies the Data Sources XML if the elements come from a MDX prompt.
Returns
  • Structure containing an element array and other status info.
Throws
MWSException
MWSException