public interface

FolderBean

implements ObjectBean
com.microstrategy.web.beans.FolderBean

Class Overview

This interface along with its super interface ObjectBean supports the concept of object browsing. It specializes the ObjectBean in the following ways:

  • Specify a system-defined folder. This includes the standard folders such as the Reports Folder or My Reports.
  • Retrieve the WebFolder interface. To walk through the list of child nodes in a folder, the transform code may operate directly on the org.w3c.dom.Document or use the WebFolder interface.
  • Specify a restriction on the type of objects returned in the folder. The getTypeRestrictions() method returns a SimpleList collection interface that allows the caller to specify a set of object types.

This interface also allows users to carry out search on objects. The default setting on the WebSearch object is in synchronized mode. The search result could be acquired through the method call getFolderObject.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract boolean cancelRequest()
Cancels the current search request.
abstract boolean getDereferenceShortcuts()
This method returns false if Shortcut objects are not to be dereferenced.
abstract WebObjectFilter getFilter()
abstract WebFolder getFolderObject()
Returns a WebFolder object representing this bean.
abstract WebSearch getSearchObject()
abstract int getSysFolder()
Returns the system folder name as defined in EnumDSSXMLFolderNames.
abstract SimpleList getTypeRestrictions()
Returns a collection of object types (EnumDSSXMLObjectTypes).
abstract boolean isSearchDefined()
Returns true if the search object was previously created using getSearchObject() call This method is useful when the intention is to just check for the existense of a search object without actually forcing the creation of one.
abstract void setDereferenceShortcuts(boolean dereferenceShortcuts)
This method sets the flag for whether to dereference shortcuts.
abstract void setFilter(WebObjectFilter value)
abstract void setIgnoreAccessDenialError(boolean ignoreAccessDenialError)
aggregationByValue
abstract void setSysFolder(int sysFolder)
Sets a new system folder name on this folder.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.ObjectBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract boolean cancelRequest ()

Cancels the current search request. This call purges the search object if possible.

Returns
  • true if successfully cancelled.

public abstract boolean getDereferenceShortcuts ()

This method returns false if Shortcut objects are not to be dereferenced. Or else, it returns true if shortcuts are dereferenced (i.e. converted to their targets). If not set, the default value is false.

Returns
  • a boolean value.

public abstract WebObjectFilter getFilter ()

public abstract WebFolder getFolderObject ()

Returns a WebFolder object representing this bean. The contents of the folder are restricted by a SimpleList collection returned from the method getTypeRestrictions.

Returns
  • a WebFolder representing this bean.
Throws
WebBeanException thrown if error occurs while retrieving the folder contents.

public abstract WebSearch getSearchObject ()

public abstract int getSysFolder ()

Returns the system folder name as defined in EnumDSSXMLFolderNames. If this folder is not a predefined system folder, returns 0.

Returns
  • the system folder name of this folder.
Throws
WebBeanException thrown if the system folder name can not be retrieved.

public abstract SimpleList getTypeRestrictions ()

Returns a collection of object types (EnumDSSXMLObjectTypes). The elements in the collection is non-repeating. This collection restricts the folder bean content to contain only those objects whose types are contained in the collection.

With respect to Shortcut objects, a shortcut is included in the output if the shortcut's target object meets the type restrictions specified here.

Returns
  • A SimpleList, containing a restricted collection of object types.

public abstract boolean isSearchDefined ()

Returns true if the search object was previously created using getSearchObject() call This method is useful when the intention is to just check for the existense of a search object without actually forcing the creation of one.

Returns
  • whether the search is defined.

public abstract void setDereferenceShortcuts (boolean dereferenceShortcuts)

This method sets the flag for whether to dereference shortcuts. Set the dereferenceShortcuts argument to be true, and shortcuts in the folder will be dereferenced. Or else, shortcuts in the folder will not be dereferenced.

public abstract void setFilter (WebObjectFilter value)

public abstract void setIgnoreAccessDenialError (boolean ignoreAccessDenialError)

aggregationByValue

public abstract void setSysFolder (int sysFolder)

Sets a new system folder name on this folder. System folder names are defined in EnumDSSXMLFolderNames and can uniquely identify a WebFolder object in a project.

Parameters
sysFolder a new system folder name.