public interface

AllObjectBrowserBean

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

Summary

Constants
int BROWSE_FOR_FOLDER
int BROWSE_FOR_OBJECTS
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract boolean allowAllObjectBrowsing()
Specifies whether the user is allowed to browse all Objects to the project level
abstract int getBrowseFor()
abstract String getStartingFolderID()
Specifies whether a specific report is configured to browse from a certain folder.
abstract WebFolder getTreeRootFolder()
Get the root folder for the entire object browser tree.
abstract 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
abstract boolean isTargetingFilter()
Gets the information of whether in report creation or filter creation
abstract 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)
abstract void setFilterTypeRestriction(String restrictions)
abstract void setHasDataExplorer(boolean hasDataExplorer)
Sets whether to use the data explorer to render the browse contents or not
abstract void setReportTypeRestriction(String restrictions)
[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

Constants

public static final int BROWSE_FOR_FOLDER

Constant Value: 0 (0x00000000)

public static final int BROWSE_FOR_OBJECTS

Constant Value: 1 (0x00000001)

Public Methods

public abstract boolean allowAllObjectBrowsing ()

Specifies whether the user is allowed to browse all Objects to the project level

public abstract int getBrowseFor ()

Returns
  • the browsing purpose of the explorer editor whether it's used in folder browsing or object browser (in report execution)

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

public abstract WebFolder getTreeRootFolder ()

Get the root folder for the entire object browser tree.

Returns
  • the root folder.

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

public abstract boolean isTargetingFilter ()

Gets the information of whether in report creation or filter creation

Returns
  • true if in filter creation mode

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

public abstract void setFilterTypeRestriction (String restrictions)

public abstract void setHasDataExplorer (boolean hasDataExplorer)

Sets whether to use the data explorer to render the browse contents or not

public abstract void setReportTypeRestriction (String restrictions)