Package com.microstrategy.web.app.beans

Interface ObjectBrowserBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, WebComponent

public interface ObjectBrowserBean
extends ReportFrameElement

Deprecated.

The class has been replaced by ObjectBrowserManagerBean.

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCurrentFolderID()	Deprecated. Returns the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser
int	getCurrentPage()	Deprecated. Get the value of the current page being browsed on the All Objects tab
int	getCurrentTab()	Deprecated. Get the tab that it's currently selected for being displayed by the Object Browser.
java.lang.String	getSearchID()	Deprecated. Get the identifier of the search currently being executed.
java.lang.String	getSearchString()	Deprecated. Get the string of the search currently being executed
void	setCurrentFolderID(java.lang.String folderID)	Deprecated. Set the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowser.
void	setCurrentPage(int pageNumber)	Deprecated. Set the value of the current page being browsed on the All Objects tab
void	setCurrentTab(int currentTab)	Deprecated. Set the tab to be displayed by the Object Browser as current one.
void	setNewSearch(boolean newSearch)	Deprecated. Defines if the search is a new one to execute or not.
void	setSearchID(java.lang.String searchID)	Deprecated. Set the identifier of the search to be executed
void	setSearchString(java.lang.String searchString)	Deprecated. Set the string of the search to be executed.

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.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

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, 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, setWebEventHandler

Method Detail

getCurrentTab

int getCurrentTab()

Deprecated.

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

Returns:

Element from the EnumObjectBrowserTabs enumeration representing the current tab.

setCurrentTab

void setCurrentTab(int currentTab)

Deprecated.

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

Parameters:

currentTab - Element from the EnumObjectBrowserTabs enumeration

getCurrentFolderID

java.lang.String getCurrentFolderID()

Deprecated.

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

Returns:

the folder ID currently being used

setCurrentFolderID

void setCurrentFolderID(java.lang.String folderID)

Deprecated.

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

getCurrentPage

int getCurrentPage()

Deprecated.

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

Returns:

the page number being displayed

setCurrentPage

void setCurrentPage(int pageNumber)

Deprecated.

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

Parameters:

pageNumber - the page number to be displayed

getSearchString

java.lang.String getSearchString()

Deprecated.

Get the string of the search currently being executed

Returns:

the string used on the current search

setSearchString

void setSearchString(java.lang.String searchString)

Deprecated.

Set the string of the search to be executed.

Parameters:

searchString - String containing the words to search for.

getSearchID

java.lang.String getSearchID()

Deprecated.

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

setSearchID

void setSearchID(java.lang.String searchID)

Deprecated.

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.

setNewSearch

void setNewSearch(boolean newSearch)

Deprecated.

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