public interface

FolderObjectExplorerBean

implements ObjectExplorerBean
com.microstrategy.web.app.beans.FolderObjectExplorerBean
Known Indirect Subclasses

Class Overview

This interface extends the ObjectExplorerBean by adding information specific to browsing a FolderBean

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getConfiguredRootFolderID()
Gets the root folder specified in the context
abstract int getContextID()
abstract FolderBean getFolderBean()
abstract int getLinksContextID()
abstract boolean getRenderRoot()
abstract String getRootFolderID()
abstract ArrayList<WebDisplayUnit> getTrimedAncestors()
Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list
abstract boolean isExcludeShortcut()
Set flag to exclude Shortcut objects from search results
abstract boolean isQuickSearch()
abstract void resetFolderBean()
abstract void setContextID(int contextID)
Sets the context id.
abstract void setExcludeShortcut(boolean excludeShortcut)
Set flag to exclude Shortcut objects from search results
abstract void setQuickSearch(boolean quickSearch)
set flag whether to use Quick Search engine
abstract void setRenderRoot(boolean renderRoot)
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ObjectExplorerBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract String getConfiguredRootFolderID ()

Gets the root folder specified in the context

public abstract int getContextID ()

Returns

public abstract FolderBean getFolderBean ()

Returns
  • the FolderBean that represents the objects contained by the editor

public abstract int getLinksContextID ()

Returns
  • the context id used to retrieve links

public abstract boolean getRenderRoot ()

public abstract String getRootFolderID ()

Returns
  • the id of the root folder the FolderBean is based on when browsing

public abstract ArrayList<WebDisplayUnit> getTrimedAncestors ()

Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list

public abstract boolean isExcludeShortcut ()

Set flag to exclude Shortcut objects from search results

public abstract boolean isQuickSearch ()

public abstract void resetFolderBean ()

public abstract void setContextID (int contextID)

Sets the context id. A value from EnumObjectBrowserContexts used to obtain the links

Parameters
contextID the context id. A value from EnumObjectBrowserContexts used to obtain the links

public abstract void setExcludeShortcut (boolean excludeShortcut)

Set flag to exclude Shortcut objects from search results

public abstract void setQuickSearch (boolean quickSearch)

set flag whether to use Quick Search engine

public abstract void setRenderRoot (boolean renderRoot)