Package com.microstrategy.web.app.beans

Interface FolderObjectExplorerBean

All Superinterfaces:

AppComponent, ObjectExplorerBean, Transformable, WebComponent

All Known Subinterfaces:

AllObjectBrowserBean, DatasetObjectExplorerBean, ImportDerivedElementsBean, ObjectManipulationDialogBean, SaveAsBean

All Known Implementing Classes:

AllObjectBrowserBeanImpl, DatasetObjectExplorerBeanImpl, FolderObjectExplorerBeanImpl

public interface FolderObjectExplorerBean
extends ObjectExplorerBean

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

Since:

MicroStrategy Web 8.0.2

Field Summary

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

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConfiguredRootFolderID()	Gets the root folder specified in the context
int	getContextID()
FolderBean	getFolderBean()
int	getLinksContextID()
boolean	getRenderRoot()
java.lang.String	getRootFolderID()
java.util.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
boolean	isExcludeShortcut()	Set flag to exclude Shortcut objects from search results
boolean	isQuickSearch()
void	resetFolderBean()
void	setContextID(int contextID)	Sets the context id.
void	setExcludeShortcut(boolean excludeShortcut)	Set flag to exclude Shortcut objects from search results
void	setQuickSearch(boolean quickSearch)	set flag whether to use Quick Search engine
void	setRenderRoot(boolean renderRoot)

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.web.app.beans.ObjectExplorerBean

getAncestors, getBlockBegin, getBlockCount, getContents, getContents, getCurrentUnit, getErrorMessage, getLinks, getObjectCount, getSearchName, getTotalObjectCount, getTypeRestriction, setBlockBegin, setBlockCount, setErrorMessage, setTypeRestriction

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

getFolderBean

FolderBean getFolderBean()

Returns:

the FolderBean that represents the objects contained by the editor

setContextID

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

getContextID

int getContextID()

Returns:

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

getRootFolderID

java.lang.String getRootFolderID()

Returns:

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

Since:

MicroStrategy Web 9.0.0

getConfiguredRootFolderID

java.lang.String getConfiguredRootFolderID()
                                    throws WebObjectsException

Gets the root folder specified in the context

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

getLinksContextID

int getLinksContextID()

Returns:

the context id used to retrieve links

Since:

MicroStrategy Web 9.0.0

getRenderRoot

boolean getRenderRoot()

Since:

MicroStrategy Web 9.0.0

setRenderRoot

void setRenderRoot(boolean renderRoot)

Since:

MicroStrategy Web 9.0.0

resetFolderBean

void resetFolderBean()

Since:

MicroStrategy Web 9.0.0

setExcludeShortcut

void setExcludeShortcut(boolean excludeShortcut)

Set flag to exclude Shortcut objects from search results

Parameters:

excludeShortcut -

isExcludeShortcut

boolean isExcludeShortcut()

Set flag to exclude Shortcut objects from search results

Parameters:

excludeShortcut -

setQuickSearch

void setQuickSearch(boolean quickSearch)

set flag whether to use Quick Search engine

Parameters:

quickSearch -

isQuickSearch

boolean isQuickSearch()

getTrimedAncestors

java.util.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

Returns: