public interface

ObjectBrowserBean

implements ReportFrameElement
com.microstrategy.web.app.beans.ObjectBrowserBean

This interface is deprecated.
The class has been replaced by ObjectBrowserManagerBean.

Class Overview

This class represents the bean that will be in charge of displaying the Object Browser that will enable users to modify the elements included on the grid.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract String getCurrentFolderID()
Returns the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser
abstract int getCurrentPage()
Get the value of the current page being browsed on the All Objects tab
abstract int getCurrentTab()
Get the tab that it's currently selected for being displayed by the Object Browser.
abstract String getSearchID()
Get the identifier of the search currently being executed.
abstract String getSearchString()
Get the string of the search currently being executed
abstract void setCurrentFolderID(String folderID)
Set the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser.
abstract void setCurrentPage(int pageNumber)
Set the value of the current page being browsed on the All Objects tab
abstract void setCurrentTab(int currentTab)
Set the tab to be displayed by the Object Browser as current one.
abstract void setNewSearch(boolean newSearch)
Defines if the search is a new one to execute or not.
abstract void setSearchID(String searchID)
Set the identifier of the search to be executed
abstract void setSearchString(String searchString)
Set the string of the search to be executed.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract String getCurrentFolderID ()

Returns the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser

Returns
  • the folder ID currently being used

public abstract int getCurrentPage ()

Get the value of the current page being browsed on the All Objects tab

Returns
  • the page number being displayed

public abstract int getCurrentTab ()

Get the tab that it's currently selected for being displayed by the Object Browser.

Returns

public abstract String getSearchID ()

Get the identifier of the search currently being executed. This identifier corresponds to the one assigned by the IServer once a search object has been executed, it does not represent the identifier of an object stored on metadata.

Returns
  • the searchID of the last search ran

public abstract String getSearchString ()

Get the string of the search currently being executed

Returns
  • the string used on the current search

public abstract void setCurrentFolderID (String folderID)

Set the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser.

Parameters
folderID sets the ID of the folder to be displayed

public abstract void setCurrentPage (int pageNumber)

Set the value of the current page being browsed on the All Objects tab

Parameters
pageNumber the page number to be displayed

public abstract void setCurrentTab (int currentTab)

Set the tab to be displayed by the Object Browser as current one.

Parameters
currentTab Element from the EnumObjectBrowserTabs enumeration

public abstract void setNewSearch (boolean newSearch)

Defines if the search is a new one to execute or not. Forces the cache of the current search identifier to be released and a new search object to get executed, based on arguments such as the search string, which should be assigned after this flag has been set to True.

Parameters
newSearch indicates if the search set is to be a new one or not

public abstract void setSearchID (String searchID)

Set the identifier of the search to be executed

Parameters
searchID String containing the ID of the search to be executed. This identifier corresponds to the one assigned by the IServer once a search object has been executed, it does not represent the identifier of an object stored on metadata.

public abstract void setSearchString (String searchString)

Set the string of the search to be executed.

Parameters
searchString String containing the words to search for.