Package com.microstrategy.web.objects

Interface WebBrowseHierarchyItem

All Superinterfaces:

KeyedObject, WebDimensionAttribute, WebDisplayUnit

public interface WebBrowseHierarchyItem
extends WebDimensionAttribute

This class reflects each of the attribute instances in a hierarchy that is selected in the context of a browsing. The objects encapsulated by this instance are not fully populated, and only have limited information pertaining to the browsing actions.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
WebElement	add(java.lang.String id, java.lang.String name)	Adds a new element to the end of the browse element chain.
java.util.Map<java.lang.String,WebElement>	getSelectedWebElements()	Returns a Map<String,WebElement> of element ID key, and WebElement value objects.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDimensionAttribute

getAttribute, getChildren, getDimension, getDiplayUnitFilters, getDrillableUnits, getFilter, getFilters, getLockLimit, getLockReason, getLockType, getParents, isEntryPoint, setFilter

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, getID, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Method Detail

getSelectedWebElements

java.util.Map<java.lang.String,WebElement> getSelectedWebElements()

Returns a Map<String,WebElement> of element ID key, and WebElement value objects. Although selected instances may be added directly to the Map, add(String, String) provides a more convenient mechanism that doesn't require a WebElement instance.

Returns:

Map<String,WebElement> of selected element ID key, and WebElement value objects.

See Also:

add(String, String)

add

WebElement add(java.lang.String id,
               java.lang.String name)

Adds a new element to the end of the browse element chain.

Parameters:

id - element ID.

name - element name.

Returns:

WebBrowseElement corresponding to the input parameters.