public interface

WebMDXSource

implements WebMDXDisplayUnit
com.microstrategy.web.objects.WebMDXSource

Class Overview

The WebMDXSource interface represents a single source of MDX data. The source contains catalogs, which each contain cubes. The source can be uniquely identified by the DBRole that belongs to it. Generally, if you are using this source in subsequent calls, the DBRole is the piece of information that must be saved.

Summary

Public Methods
abstract WebMDXCatalog get(int i)
Returns the WebMDXCatalog at the given index in the source's collection of catalogs.
abstract WebDisplayUnits getChildUnits()
Returns a WebDisplayUnits collection containing all catalogs that belong to the MDXSource.
abstract WebDBRole getDBRole()
Returns the WebDBRole object that the source refers to.
abstract int size()
Returns the number of catalogs in the collection.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebMDXDisplayUnit

Public Methods

public abstract WebMDXCatalog get (int i)

Returns the WebMDXCatalog at the given index in the source's collection of catalogs. Note that the same information can be accessed by calling the getChildUnits method.

Returns
Throws
WebObjectsException Thrown if an error occurs when retrieving the child objects.

public abstract WebDisplayUnits getChildUnits ()

Returns a WebDisplayUnits collection containing all catalogs that belong to the MDXSource.

Returns
Throws
WebObjectsException Thrown if an error occurs when retrieving the child objects.

public abstract WebDBRole getDBRole ()

Returns the WebDBRole object that the source refers to.

Returns

public abstract int size ()

Returns the number of catalogs in the collection.

Returns
  • The size of the catalogs collection.
Throws
WebObjectsException Thrown if an error occurs when retrieving the child objects.