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

AllObjectBrowserBeanImpl, DatasetObjectExplorerBeanImpl

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

From class com.microstrategy.utils.serialization.AbstractPersistable

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(boolean sortAscending)
ArrayList	getContents()
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

void	doCollectData() Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.
DocumentFrameBean	getDocumentFrameBean() Returns the `DocumentFrameBean` associated with this report frame element.
WebFeatures	getFeaturesManager() Overrides getFeaturesManager by providing a new Features implementation for FrameElements.
FrameBean	getFrameBean() Utility method for returning the `FrameBean` associated with this instance
RWFrameBean	getRWFrameBean() Returns the `RWFrameBean` associated with this report frame element.
ReportFrameBean	getReportFrameBean() Returns the `ReportFrameBean` associated with this report frame element.
boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
boolean	isGridDataNecessary() This method indicates the report frame that the element requires the grid for information.
boolean	isIFrameEnabled()
boolean	isOpen() Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setIsOpen(boolean value) Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status.
void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

From interface com.microstrategy.utils.serialization.Persistable

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

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.

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

public String getConfiguredRootFolderID ()

Gets the root folder specified in the context

Throws

WebObjectsException

public ArrayList getContents (boolean sortAscending)

public ArrayList getContents ()

public int getContextID ()

public WebDisplayUnit getCurrentUnit ()

public FolderBean getFolderBean ()

public ArrayList getLinks ()

public int getLinksContextID ()

get the contextID used by links

public int getObjectCount ()

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

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

The name of the FolderBean created by getFolderBean()

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

Interfaces

Classes

Exceptions

FolderObjectExplorerBeanImpl

Class Overview

Summary

Fields

protected ArrayList _ancestors

protected int _rootSysFolder

protected ArrayList _trimedAncestors

Public Constructors

public FolderObjectExplorerBeanImpl ()

Public Methods

public void doCollectData ()

public ArrayList getAncestors ()

See Also

public String getConfiguredRootFolderID ()

Throws

public ArrayList getContents (boolean sortAscending)

See Also

public ArrayList getContents ()

See Also

public int getContextID ()

See Also

public WebDisplayUnit getCurrentUnit ()

See Also

public FolderBean getFolderBean ()

See Also

public ArrayList getLinks ()

See Also

public int getLinksContextID ()

public int getObjectCount ()

See Also

public boolean getRenderRoot ()

public String getRootFolderID ()

public String getSearchName ()

See Also

public int getTotalObjectCount ()

See Also

public ArrayList<WebDisplayUnit> getTrimedAncestors ()

public boolean handleRequest (RequestKeys keys)

Parameters

Returns

Throws

public boolean isExcludeShortcut ()

public boolean isQuickSearch ()

public void resetFolderBean ()

public void setContextID (int contextID)

Parameters

See Also

public void setExcludeShortcut (boolean excludeShortcut)

public void setIgnoreAccessDenialError (boolean ignoreAccessDenialError)

public void setQuickSearch (boolean quickSearch)

public void setRenderRoot (boolean renderRoot)

Protected Methods

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

Parameters

protected String getFolderBeanName ()

Returns

protected WebFolder getFolderFromFolderLink (FolderLink fl)

protected String getProjectID ()

Returns

protected WebEventHandler newDefaultEventHandler ()

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

protected void setupFolderBean ()