Package com.microstrategy.web.objects
Interface WebMDXSource
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebMDXDisplayUnit
public interface WebMDXSource extends WebMDXDisplayUnit
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.- Since:
- MicroStrategy Web 8.0.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebMDXCatalog
get(int i)
Returns theWebMDXCatalog
at the given index in the source's collection of catalogs.WebDisplayUnits
getChildUnits()
Returns aWebDisplayUnits
collection containing all catalogs that belong to the MDXSource.WebDBRole
getDBRole()
Returns theWebDBRole
object that the source refers to.int
size()
Returns the number of catalogs in the collection.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getDisplayName, getDisplayUnitType, getID, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebMDXDisplayUnit
getParent, getPathComponent, getSourceObject, isContainer, isPrunable
-
-
-
-
Method Detail
-
getDBRole
WebDBRole getDBRole()
Returns theWebDBRole
object that the source refers to.- Returns:
- The
WebDBRole
object linked to the source.
-
get
WebMDXCatalog get(int i) throws WebObjectsException
Returns theWebMDXCatalog
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:
- The
WebMDXCatalog
object at the given index. - Throws:
WebObjectsException
- Thrown if an error occurs when retrieving the child objects.
-
size
int size() throws WebObjectsException
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.
-
getChildUnits
WebDisplayUnits getChildUnits() throws WebObjectsException
Returns aWebDisplayUnits
collection containing all catalogs that belong to the MDXSource.- Specified by:
getChildUnits
in interfaceWebDisplayUnit
- Returns:
- A
WebDisplayUnits
collection containing the catalogs. - Throws:
WebObjectsException
- Thrown if an error occurs when retrieving the child objects.
-
-