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
From interface com.microstrategy.web.app.beans.ObjectBrowserTabBean
From interface com.microstrategy.web.app.beans.TabBean
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

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

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.