public interface

GroupPathBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.GroupPathBean

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getBrowsingPath()
This property indicates the path events to browse (like select-ancestor) will follow.
abstract List getPathElements()
Returns a read-only list over the user groups having been visited in order.
abstract void setBrowsingPath(String path)
This property indicates the path events to browse should follow.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract 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.

public abstract 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.

public abstract void setBrowsingPath (String path)

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