public interface

DatasetObjectExplorerBean

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

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getBaseFolderId()
abstract String getFolderId()
abstract String getTargetTemplateKey()
abstract boolean isRestrictBrowse()
abstract boolean isRootFolder()
abstract void setFolderId(String folderId)
Set the folder identifier where the explorer will be opened by default
abstract void setRestrictBrowse(boolean value)
Define whether the user will be able to browse above (or parents) the folder specified as base for this explorer
abstract void setTargetTemplateKey(String key)
Set the key of the template to be the target of the manipulation requested with this explorer
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FolderObjectExplorerBean
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 getBaseFolderId ()

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

public abstract String getFolderId ()

Returns
  • the folder identifier where the explorer will be opened by default

public abstract String getTargetTemplateKey ()

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

public abstract boolean isRestrictBrowse ()

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

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

public abstract void setFolderId (String folderId)

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

Parameters
folderId String

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

public abstract void setTargetTemplateKey (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