Package com.microstrategy.web.app.beans
Interface AllObjectBrowserBean
-
- All Superinterfaces:
AppComponent
,FolderObjectExplorerBean
,ObjectExplorerBean
,Transformable
,WebComponent
- All Known Implementing Classes:
AllObjectBrowserBeanImpl
public interface AllObjectBrowserBean extends FolderObjectExplorerBean
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
BROWSE_FOR_FOLDER
static int
BROWSE_FOR_OBJECTS
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
allowAllObjectBrowsing()
Specifies whether the user is allowed to browse all Objects to the project levelint
getBrowseFor()
java.lang.String
getStartingFolderID()
Specifies whether a specific report is configured to browse from a certain folder.WebFolder
getTreeRootFolder()
Get the root folder for the entire object browser tree.boolean
hasDataExplorer()
Gets the information of whether to use the data explorer to render the browse contents or not NOTE: used when browsing from attributes to the elementsboolean
isTargetingFilter()
Gets the information of whether in report creation or filter creationvoid
setBrowseFor(int browseFor)
Sets the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)void
setFilterTypeRestriction(java.lang.String restrictions)
void
setHasDataExplorer(boolean hasDataExplorer)
Sets whether to use the data explorer to render the browse contents or notvoid
setReportTypeRestriction(java.lang.String restrictions)
-
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.FolderObjectExplorerBean
getConfiguredRootFolderID, getContextID, getFolderBean, getLinksContextID, getRenderRoot, getRootFolderID, getTrimedAncestors, isExcludeShortcut, isQuickSearch, resetFolderBean, setContextID, setExcludeShortcut, setQuickSearch, setRenderRoot
-
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
-
-
-
-
Field Detail
-
BROWSE_FOR_FOLDER
static final int BROWSE_FOR_FOLDER
- See Also:
- Constant Field Values
-
BROWSE_FOR_OBJECTS
static final int BROWSE_FOR_OBJECTS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getBrowseFor
int getBrowseFor()
- Returns:
- the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)
-
setBrowseFor
void setBrowseFor(int browseFor)
Sets the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)
-
setHasDataExplorer
void setHasDataExplorer(boolean hasDataExplorer)
Sets whether to use the data explorer to render the browse contents or not
-
setReportTypeRestriction
void setReportTypeRestriction(java.lang.String restrictions)
-
setFilterTypeRestriction
void setFilterTypeRestriction(java.lang.String restrictions)
-
hasDataExplorer
boolean hasDataExplorer()
Gets the information of whether to use the data explorer to render the browse contents or not NOTE: used when browsing from attributes to the elements
-
isTargetingFilter
boolean isTargetingFilter()
Gets the information of whether in report creation or filter creation- Returns:
- true if in filter creation mode
-
allowAllObjectBrowsing
boolean allowAllObjectBrowsing()
Specifies whether the user is allowed to browse all Objects to the project level
-
getStartingFolderID
java.lang.String getStartingFolderID()
Specifies whether a specific report is configured to browse from a certain folder.- Returns:
- the folder ID if the report is configured with a specific browsing point.
-
getTreeRootFolder
WebFolder getTreeRootFolder()
Get the root folder for the entire object browser tree.- Returns:
- the root folder.
-
-