public class

FolderObjectExplorerBeanImpl

extends AbstractObjectExplorerBean
implements FolderObjectExplorerBean
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.beans.AbstractTransformable
       ↳ com.microstrategy.web.beans.AbstractWebComponent
         ↳ com.microstrategy.web.app.beans.AbstractAppComponent
           ↳ com.microstrategy.web.app.beans.AbstractPersistableAppComponent
             ↳ com.microstrategy.web.app.beans.AbstractPersistableFrameElement
               ↳ com.microstrategy.web.app.beans.AbstractObjectExplorerBean
                 ↳ com.microstrategy.web.app.beans.FolderObjectExplorerBeanImpl
Known Direct Subclasses

Class Overview

Implementation of the FolderObjectExplorerBean that represents an editor used to browse the contents of a FolderBean

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Fields
protected ArrayList _ancestors
protected int _rootSysFolder
protected ArrayList _trimedAncestors
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
FolderObjectExplorerBeanImpl()
Public Methods
void doCollectData()
Extends collectData by initializing the folder bean
ArrayList getAncestors()
String getConfiguredRootFolderID()
Gets the root folder specified in the context
ArrayList getContents()
ArrayList getContents(boolean sortAscending)
int getContextID()
WebDisplayUnit getCurrentUnit()
FolderBean getFolderBean()
ArrayList getLinks()
int getLinksContextID()
get the contextID used by links
int getObjectCount()
boolean getRenderRoot()
String getRootFolderID()
This method returns the ID of the root folder of the editor it can be read either from the list of configured links or a plugin
String getSearchName()
int getTotalObjectCount()
ArrayList<WebDisplayUnit> getTrimedAncestors()
Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list
boolean handleRequest(RequestKeys keys)
Handles the request specified by the RequestKeys instance.
boolean isExcludeShortcut()
Set flag to exclude Shortcut objects from search results
boolean isQuickSearch()
void resetFolderBean()
void setContextID(int contextID)
Sets the context id.
void setExcludeShortcut(boolean excludeShortcut)
Set flag to exclude Shortcut objects from search results
void setIgnoreAccessDenialError(boolean ignoreAccessDenialError)
void setQuickSearch(boolean quickSearch)
set flag whether to use Quick Search engine
void setRenderRoot(boolean renderRoot)
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Proceses the save/restore state opperation of the AppComponent
String getFolderBeanName()
WebFolder getFolderFromFolderLink(FolderLink fl)
String getProjectID()
Get the Project ID from the session manager
WebEventHandler newDefaultEventHandler()
void restoreTypeRestrictions(boolean restoring, FlatStateSerializer serializer, FlatStateTokenizer tokenizer)
void setupFolderBean()
Initialize a FolderBean instance in order to process the folder information to be displayed as part of the explorer bean's interface
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractObjectExplorerBean
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FolderObjectExplorerBean
From interface com.microstrategy.web.app.beans.ObjectExplorerBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Fields

protected ArrayList _ancestors

protected int _rootSysFolder

protected ArrayList _trimedAncestors

Public Constructors

public FolderObjectExplorerBeanImpl ()

Public Methods

public void doCollectData ()

Extends collectData by initializing the folder bean

public ArrayList getAncestors ()

See Also

public String getConfiguredRootFolderID ()

Gets the root folder specified in the context

public ArrayList getContents ()

See Also

public ArrayList getContents (boolean sortAscending)

public int getContextID ()

See Also

public WebDisplayUnit getCurrentUnit ()

See Also

public FolderBean getFolderBean ()

See Also

public ArrayList getLinks ()

See Also

public int getLinksContextID ()

get the contextID used by links

public int getObjectCount ()

See Also

public boolean getRenderRoot ()

public String getRootFolderID ()

This method returns the ID of the root folder of the editor it can be read either from the list of configured links or a plugin

public String getSearchName ()

See Also

public int getTotalObjectCount ()

public ArrayList<WebDisplayUnit> getTrimedAncestors ()

Get an List of WebDisplayUnit objects containing the list of of the current object's ancestors (parent folders), it will trim the user profile folder if it is in the ancestor list

public boolean handleRequest (RequestKeys keys)

Handles the request specified by the RequestKeys instance. The RequestKeys object might contain all information sent from the Web browser along with any cookies, session variables, etc. Most importantly, it contains WebEvent related information. If this instance in the namespace of the src request key attribute, it will forward the request to its associated event handler.

Parameters
keys the RequestKeys object.
Returns
  • true if the request is successfully handled; false if the request or event is not supported.
Throws
WebException

public boolean isExcludeShortcut ()

Set flag to exclude Shortcut objects from search results

public boolean isQuickSearch ()

public void resetFolderBean ()

public void setContextID (int contextID)

Sets the context id. A value from EnumObjectBrowserContexts used to obtain the links

Parameters
contextID the context id. A value from EnumObjectBrowserContexts used to obtain the links

public void setExcludeShortcut (boolean excludeShortcut)

Set flag to exclude Shortcut objects from search results

public void setIgnoreAccessDenialError (boolean ignoreAccessDenialError)

public void setQuickSearch (boolean quickSearch)

set flag whether to use Quick Search engine

public void setRenderRoot (boolean renderRoot)

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters
serializer an instance of the FlatStateSerializer object to use
howMuchState defines how much information needs to be saved
tokenizer an instance of the FlatStateTokenizer object to use

protected String getFolderBeanName ()

Returns

protected WebFolder getFolderFromFolderLink (FolderLink fl)

protected String getProjectID ()

Get the Project ID from the session manager

Returns
  • String projectID

protected WebEventHandler newDefaultEventHandler ()

protected void restoreTypeRestrictions (boolean restoring, FlatStateSerializer serializer, FlatStateTokenizer tokenizer)

protected void setupFolderBean ()

Initialize a FolderBean instance in order to process the folder information to be displayed as part of the explorer bean's interface