Package com.microstrategy.web.app.beans

Interface DatasetObjectExplorerBean

All Superinterfaces:

AppComponent, FolderObjectExplorerBean, ObjectExplorerBean, Transformable, WebComponent

All Known Implementing Classes:

DatasetObjectExplorerBeanImpl

public interface DatasetObjectExplorerBean
extends FolderObjectExplorerBean

This interface extends the FolderObjectExplorerBean by adding information specific to browsing a FolderBean within Dataset linking context.

Since:

MicroStrategy Web 8.1.0

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	getBaseFolderId()
java.lang.String	getFolderId()
java.lang.String	getTargetTemplateKey()
boolean	isRestrictBrowse()
boolean	isRootFolder()
void	setFolderId(java.lang.String folderId)	Set the folder identifier where the explorer will be opened by default
void	setRestrictBrowse(boolean value)	Define whether the user will be able to browse above (or parents) the folder specified as base for this explorer
void	setTargetTemplateKey(java.lang.String key)	Set the key of the template to be the target of the manipulation requested with this explorer

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

Method Detail

getFolderId

java.lang.String getFolderId()

Returns:

the folder identifier where the explorer will be opened by default

setFolderId

void setFolderId(java.lang.String folderId)

Set the folder identifier where the explorer will be opened by default

Parameters:

folderId - String

getTargetTemplateKey

java.lang.String getTargetTemplateKey()

Returns:

String value with the key of the template to be the target of the manipulation requested with this explorer

setTargetTemplateKey

void setTargetTemplateKey(java.lang.String key)

Set the key of the template to be the target of the manipulation requested with this explorer

Parameters:

key - String value with the target template key

isRootFolder

boolean isRootFolder()

Returns:

boolean value indicating if the current folder being viewed on the explorer is the root, as indicated on the folder links configuration

getBaseFolderId

java.lang.String getBaseFolderId()

Returns:

String value with the id of the folder indicated to be the base, or starting point, for the explorer

isRestrictBrowse

boolean isRestrictBrowse()

Returns:

boolean value indicating if the browsing action has been restricted for the user

setRestrictBrowse

void setRestrictBrowse(boolean value)

Define whether the user will be able to browse above (or parents) the folder specified as base for this explorer

Parameters:

value - boolean indicating if the browsing action has been restricted for the user