Package com.microstrategy.web.app.beans
Interface RWProjectBrowserTabBean
-
- All Superinterfaces:
AppComponent
,ObjectBrowserTabBean
,TabBean
,Transformable
,ViewBeanParserBean
,WebComponent
public interface RWProjectBrowserTabBean extends ObjectBrowserTabBean
Deprecated.THe interface is no longer used by WebInterface for the bean that will allow users to have a project browser, with the ability of running searches, browsing ancestor folders, etc.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.web.app.beans.ObjectBrowserTabBean
CONTENTS_TYPE_RWDATAELEMENTS, CONTENTS_TYPE_WEB_WORKING_SET, CONTENTS_TYPE_WEBFOLDER
-
Fields inherited from interface com.microstrategy.web.app.beans.TabBean
CACHED, FETCH, TAB_REPRESENTED_NOT_SPECIFIED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getContextID()
Deprecated.Get the context ID of the object browser instance.WebFolder
getCurrentFolder()
Deprecated.Get theWebFolder
instance currently selected by the user for viewing its contents.java.lang.String
getCurrentFolderID()
Deprecated.Returns the folderID of the object currently being displayed on the All Objects tab by the ObjectBrowserint
getCurrentPage()
Deprecated.Get the value of the current page being browsed on the All Objects tabWebFolder
getFolderLinkObject(FolderLink folderLink)
Deprecated.returns theWebFolder
object corresponding to the Folder Link.SimpleList
getFolderLinks()
Deprecated.Get the folderLinks for the object browser as a SimpleList collection.WebObjectSource
getObjectSource()
Deprecated.Utility method for obtaining theWebObjectSource
instance to be used for preparing the searches and folder browsing as requested by the user.int
getPageSize()
Deprecated.Returns the block size of folder contents to be displayed at one time.int[]
getSearchFilterTypes()
Deprecated.Returns the object types tp filter the folder contents/search results byjava.lang.String
getSearchID()
Deprecated.Get the ID of the search currently being executedjava.lang.String
getSearchString()
Deprecated.Get the string of the search currently being executedboolean
isCurrentEqualFolderLink()
Deprecated.This indicates if the current folder is the same as one of the shortcuts/folderLinks defined on objBrowserFolderLinks.xml file.boolean
isCurrentEqualRootFolder()
Deprecated.Specifies if the current folder is the same as the root folder.void
setContextID(int contextID)
Deprecated.Set the context ID of the object browser instance.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 tabvoid
setNewSearch(boolean newSearch)
Deprecated.Defines if the search is a new one to execute or notvoid
setSearchFilterTypes(int[] value)
Deprecated.Set the object types to filter the folder contents/search results byvoid
setSearchID(java.lang.String searchID)
Deprecated.Set the ID of the search to be executedvoid
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.ObjectBrowserTabBean
getContents, getContentsType, getDesignModeStage, getObjectFilter, getObjectFilter, isTargetingFilter, prepareTabContentsList, setDesignModeStage, setObjectFilter
-
Methods inherited from interface com.microstrategy.web.app.beans.TabBean
getEnabledCmdId, getFeatures, getHelpTopic, getHelpType, getRequireSingleSelector, getSupportedTypes, getSwitchMode, getTabId, getTabLabel, getTabLabelId, getTabManager, getTabName, getTabRepresented, getViewBean, isAvailable, isPartialUpdate, setEnabledCmdId, setFeatures, setHelpTopic, setHelpType, setPartialUpdate, setRequireSingleSelector, setSupportedTypes, setSwitchMode, setTabLabel, setTabLabelId, setTabName, setTabRepresented
-
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.app.beans.ViewBeanParserBean
getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, setActiveElementIndex, setActiveViewKey
-
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, getTargetBean, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
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
-
getCurrentFolder
WebFolder getCurrentFolder()
Deprecated.Get theWebFolder
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 thegetCurrentFolderID()
method.
-
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 ID of the search currently being executed- Returns:
- the searchID of the last search ran
-
setSearchID
void setSearchID(java.lang.String searchID)
Deprecated.Set the ID of the search to be executed- Parameters:
searchID
- String containing the ID of the search to be executed
-
setNewSearch
void setNewSearch(boolean newSearch)
Deprecated.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
-
getObjectSource
WebObjectSource getObjectSource()
Deprecated.Utility method for obtaining theWebObjectSource
instance to be used for preparing the searches and folder browsing as requested by the user.- Returns:
- a
WebObjectSource
initialized instance.
-
getPageSize
int getPageSize()
Deprecated.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.
-
setContextID
void setContextID(int contextID)
Deprecated.Set the context ID of the object browser instance. Valid values that are fromEnumObjectBrowserContexts
enumeration- Parameters:
contextID
- int
-
getContextID
int getContextID()
Deprecated.Get the context ID of the object browser instance. Valid values that are fromEnumObjectBrowserContexts
enumeration- Returns:
- int
-
getFolderLinks
SimpleList getFolderLinks()
Deprecated.Get the folderLinks for the object browser as a SimpleList collection. The folderLinks configured through the objBrowserFolderLinks.xml file- Returns:
- SimpleList
-
isCurrentEqualRootFolder
boolean isCurrentEqualRootFolder()
Deprecated.Specifies if the current folder is the same as the root folder.- Returns:
- boolean
-
setSearchFilterTypes
void setSearchFilterTypes(int[] value)
Deprecated.Set the object types to filter the folder contents/search results by- Parameters:
value
-
-
getSearchFilterTypes
int[] getSearchFilterTypes()
Deprecated.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.
-
isCurrentEqualFolderLink
boolean isCurrentEqualFolderLink()
Deprecated.This indicates if the current folder is the same as one of the shortcuts/folderLinks defined on objBrowserFolderLinks.xml file.- Returns:
- boolean
-
getFolderLinkObject
WebFolder getFolderLinkObject(FolderLink folderLink)
Deprecated.returns theWebFolder
object corresponding to the Folder Link. The object will be populated.- Parameters:
folderLink
-- Returns:
- folder corresponding to the folder link.
-
-