Package com.microstrategy.web.app.beans

Interface GroupPathBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

public interface GroupPathBean
extends AppComponent, RequestPersistable

The interface GroupPathBean is responsible to keep track of the user groups being visited.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBrowsingPath()	This property indicates the path events to browse (like select-ancestor) will follow.
java.util.List	getPathElements()	Returns a read-only list over the user groups having been visited in order.
void	setBrowsingPath(java.lang.String path)	This property indicates the path events to browse should follow.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getPathElements

java.util.List getPathElements()

Returns a read-only list over the user groups having been visited in order. This list does not include the current user group being visited. The returned user groups are of type WebUserGroup.

Returns:

a read-only list over the user groups having been visited in order.

setBrowsingPath

void setBrowsingPath(java.lang.String path)

This property indicates the path events to browse should follow. This will be set as the source for the set ancestors events.

getBrowsingPath

java.lang.String getBrowsingPath()

This property indicates the path events to browse (like select-ancestor) will follow. If not set, this property returns the same value as this bean's path.