Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

RWProjectBrowserTabBean

implements ObjectBrowserTabBean

com.microstrategy.web.app.beans.RWProjectBrowserTabBean

This interface is deprecated.
THe interface is no longer used by Web

Class Overview

Interface for the bean that will allow users to have a project browser, with the ability of running searches, browsing ancestor folders, etc.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.app.beans.AppComponent

From interface com.microstrategy.web.app.beans.ObjectBrowserTabBean

From interface com.microstrategy.web.app.beans.TabBean

Public Methods
abstract int	getContextID() Get the context ID of the object browser instance.
abstract WebFolder	getCurrentFolder() Get the `WebFolder` instance currently selected by the user for viewing its contents.
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 WebFolder	getFolderLinkObject(FolderLink folderLink) returns the `WebFolder` object corresponding to the Folder Link.
abstract SimpleList	getFolderLinks() Get the folderLinks for the object browser as a SimpleList collection.
abstract WebObjectSource	getObjectSource() Utility method for obtaining the `WebObjectSource` instance to be used for preparing the searches and folder browsing as requested by the user.
abstract int	getPageSize() Returns the block size of folder contents to be displayed at one time.
abstract int[]	getSearchFilterTypes() Returns the object types tp filter the folder contents/search results by
abstract String	getSearchID() Get the ID of the search currently being executed
abstract String	getSearchString() Get the string of the search currently being executed
abstract boolean	isCurrentEqualFolderLink() This indicates if the current folder is the same as one of the shortcuts/folderLinks defined on objBrowserFolderLinks.xml file.
abstract boolean	isCurrentEqualRootFolder() Specifies if the current folder is the same as the root folder.
abstract void	setContextID(int contextID) Set the context ID of the object browser instance.
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	setNewSearch(boolean newSearch) Defines if the search is a new one to execute or not
abstract void	setSearchFilterTypes(int[] value) Set the object types to filter the folder contents/search results by
abstract void	setSearchID(String searchID) Set the ID 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.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.ObjectBrowserTabBean

abstract Object	getContents() Get an instance with the contents to be rendered on the tab
abstract int	getContentsType() This method allows users of this interface to know the type of output to expect from the `getContents()` method, since for example, in some cases, it might be a `WebFolder` instance (when returning searches, folder browsing or report working set information) or a `RWDataSets` instance (when returning data element information from a report writing bean)
abstract int	getDesignModeStage() Get the stage of the design mode (`EnumReportDesignMode`).
abstract int[]	getObjectFilter() Get an array of object subtypes to use for filtering when a search is run.
abstract int[]	getObjectFilter(int targetMode) Get an array of object subtypes to use for filtering when a search is run.
abstract boolean	isTargetingFilter() Returns if the object browser is targeting the filter or not
abstract void	prepareTabContentsList() Prepare the list of contents this tab will get displayed to the user.
abstract void	setDesignModeStage(int designModeStage) Holds the stage of the design mode (`EnumReportDesignMode`) .
abstract void	setObjectFilter(String objectFilter) Set the filter to use when obtaining the contents to display.

From interface com.microstrategy.web.app.beans.TabBean

abstract String	getEnabledCmdId() Get the command id to be queried on the clioent site.
abstract String	getFeatures() Gets a list of feature ids that are required to enable the tab
abstract String	getHelpTopic() get the help topic of this tab
abstract String	getHelpType() get the type of the help file
abstract boolean	getRequireSingleSelector() Each instance of this class represents a tab in the `TabManagerBean`.
abstract String	getSupportedTypes() Get the list of objects this tab can be associated with.
abstract int	getSwitchMode() Gets the switch mode of the tab bean
abstract String	getTabId() Returns a string can be used as the identifier of the tab.
abstract String	getTabLabel() Get the description text to be used as title for the display of the tab.
abstract String	getTabLabelId() Get the identifier of the descriptor to be used as title for the display of the tab.
abstract TabManagerBean	getTabManager() Utility method for obtaining the parent tabe manager associated to this tab
abstract String	getTabName() Each instance of this class represents a tab in the `TabManagerBean`.
abstract int	getTabRepresented() Each instance of this class represents a tab in the `TabManagerBean`.
abstract ViewBean	getViewBean() Utility method for obtaining the `ViewBean` indicated as target bean for this tab instance.
abstract boolean	isAvailable() This method specifies if in the current scenario, the bean instance can be displayed as possible tab option, based on granted privileges, etc.
abstract boolean	isPartialUpdate()
abstract void	setEnabledCmdId(String value) Set the command id to be queried on the client site.
abstract void	setFeatures(String featureIds) Sets a list of feature ids that are required to enable the tab
abstract void	setHelpTopic(String topic) set the help topic of the editor
abstract void	setHelpType(String type) set the help type for the editor
abstract void	setPartialUpdate(boolean paritalUpdate)
abstract void	setRequireSingleSelector(boolean requireSingleSelector) Each instance of this class represents a tab in the `TabManagerBean`.
abstract void	setSupportedTypes(String supportedTYpes) Set the list of objects this tab can be associated with.
abstract void	setSwitchMode(int switchMode) Sets the switch mode of the tab bean (client side switch or server side switch)
abstract void	setTabLabel(String description) Set the description text to be used as title for the display of the tab.
abstract void	setTabLabelId(String descriptionId) Set the identifier of the descriptor to be used as title for the display of the tab.
abstract void	setTabName(String tabName) Each instance of this class represents a tab in the `TabManagerBean`.
abstract void	setTabRepresented(int tab) Each instance of this class represents a tab in the `TabManagerBean`.

From interface com.microstrategy.web.app.beans.ViewBeanParserBean

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Public Methods

public abstract int getContextID ()

Get the context ID of the object browser instance. Valid values that are from EnumObjectBrowserContexts enumeration

Returns

int

public abstract WebFolder getCurrentFolder ()

Get the WebFolder instance currently selected by the user for viewing its contents.

Returns

a WebFolder instance corresponding to the current folder viewed by the user, and to the id available with the getCurrentFolderID() method.

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 WebFolder getFolderLinkObject (FolderLink folderLink)

returns the WebFolder object corresponding to the Folder Link. The object will be populated.

Returns

folder corresponding to the folder link.

public abstract SimpleList getFolderLinks ()

Get the folderLinks for the object browser as a SimpleList collection. The folderLinks configured through the objBrowserFolderLinks.xml file

Returns

SimpleList

public abstract WebObjectSource getObjectSource ()

Utility method for obtaining the WebObjectSource instance to be used for preparing the searches and folder browsing as requested by the user.

Returns

a WebObjectSource initialized instance.

public abstract int getPageSize ()

Returns the block size of folder contents to be displayed at one time.

Returns

an integer value with the number of elements to display per page.

public abstract int[] getSearchFilterTypes ()

Returns the object types tp filter the folder contents/search results by

Returns

an arrey of integer values, each one representing the filter types that are included, normally elements of the EnumDSSXMLObjectSubTypes enumeration.

public abstract String getSearchID ()

Get the ID of the search currently being executed

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 boolean isCurrentEqualFolderLink ()

This indicates if the current folder is the same as one of the shortcuts/folderLinks defined on objBrowserFolderLinks.xml file.

Returns

boolean

public abstract boolean isCurrentEqualRootFolder ()

Specifies if the current folder is the same as the root folder.

Returns

boolean

public abstract void setContextID (int contextID)

Set the context ID of the object browser instance. Valid values that are from EnumObjectBrowserContexts enumeration

Parameters

contextID	int

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 setNewSearch (boolean newSearch)

Defines if the search is a new one to execute or not

Parameters

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

public abstract void setSearchFilterTypes (int[] value)

Set the object types to filter the folder contents/search results by

public abstract void setSearchID (String searchID)

Set the ID of the search to be executed

Parameters

searchID	String containing the ID of the search to be executed

public abstract void setSearchString (String searchString)

Set the string of the search to be executed.

Parameters

searchString	String containing the words to search for.

Interfaces

Classes

Exceptions

RWProjectBrowserTabBean

Class Overview

Summary

Public Methods

public abstract int getContextID ()

Returns

public abstract WebFolder getCurrentFolder ()

Returns

public abstract String getCurrentFolderID ()

Returns

public abstract int getCurrentPage ()

Returns

public abstract WebFolder getFolderLinkObject (FolderLink folderLink)

Returns

public abstract SimpleList getFolderLinks ()

Returns

public abstract WebObjectSource getObjectSource ()

Returns

public abstract int getPageSize ()

Returns

public abstract int[] getSearchFilterTypes ()

Returns

public abstract String getSearchID ()

Returns

public abstract String getSearchString ()

Returns

public abstract boolean isCurrentEqualFolderLink ()

Returns

public abstract boolean isCurrentEqualRootFolder ()

Returns

public abstract void setContextID (int contextID)

Parameters

public abstract void setCurrentFolderID (String folderID)

Parameters

public abstract void setCurrentPage (int pageNumber)

Parameters

public abstract void setNewSearch (boolean newSearch)

Parameters

public abstract void setSearchFilterTypes (int[] value)

public abstract void setSearchID (String searchID)

Parameters

public abstract void setSearchString (String searchString)

Parameters