Package com.microstrategy.web.beans
Interface FolderBean
-
- All Superinterfaces:
EnumWebPersistableState
,ObjectBean
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
public interface FolderBean extends ObjectBean
This interface along with its super interfaceObjectBean
supports the concept of object browsing. It specializes theObjectBean
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 theorg.w3c.dom.Document
or use theWebFolder
interface. - Specify a restriction on the type of objects returned in the folder.
The
getTypeRestrictions()
method returns aSimpleList
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 callgetFolderObject
.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
cancelRequest()
Cancels the current search request.boolean
getDereferenceShortcuts()
This method returns false if Shortcut objects are not to be dereferenced.WebObjectFilter
getFilter()
WebFolder
getFolderObject()
Returns aWebFolder
object representing this bean.WebSearch
getSearchObject()
int
getSysFolder()
Returns the system folder name as defined inEnumDSSXMLFolderNames
.SimpleList
getTypeRestrictions()
Returns a collection of object types (EnumDSSXMLObjectTypes
).boolean
isBlockBeginReset()
Get whether current folder bean's blockBegin is reset.boolean
isSearchDefined()
Returns true if the search object was previously created usinggetSearchObject()
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.void
setBlockBeginReset(boolean isReset)
Set whether current folder bean's blockBegin is reset.void
setDereferenceShortcuts(boolean dereferenceShortcuts)
This method sets the flag for whether to dereference shortcuts.void
setFilter(WebObjectFilter value)
void
setIgnoreAccessDenialError(boolean ignoreAccessDenialError)
void
setSysFolder(int sysFolder)
Sets a new system folder name on this folder.-
Methods inherited from interface com.microstrategy.web.beans.ObjectBean
getBlockBegin, getBlockCount, getDisplayName, getFlags, getLevel, getObjectID, getObjectInfo, getObjectName, getObjectType, getParentFolderBean, getParentFolderBean, getParentID, setBlockBegin, setBlockCount, setFlags, setLevel, setObjectID, setObjectInfo, setObjectName, setObjectType
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
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.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale
-
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
-
getSysFolder
int getSysFolder() throws WebBeanException
Returns the system folder name as defined inEnumDSSXMLFolderNames
. 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.
-
setSysFolder
void setSysFolder(int sysFolder)
Sets a new system folder name on this folder. System folder names are defined inEnumDSSXMLFolderNames
and can uniquely identify aWebFolder
object in a project.- Parameters:
sysFolder
- a new system folder name.
-
getFolderObject
WebFolder getFolderObject() throws WebBeanException
Returns aWebFolder
object representing this bean. The contents of the folder are restricted by aSimpleList
collection returned from the methodgetTypeRestrictions
.- Returns:
- a
WebFolder
representing this bean. - Throws:
WebBeanException
- thrown if error occurs while retrieving the folder contents.
-
getTypeRestrictions
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.
-
setDereferenceShortcuts
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.- Since:
- MicroStrategy Web 9.0.0
- See Also:
WebFolder.setDereferenceShortcuts(boolean)
-
getDereferenceShortcuts
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.
- Since:
- MicroStrategy Web 9.0.0
- See Also:
WebFolder.getDereferenceShorcuts()
-
getSearchObject
WebSearch getSearchObject()
-
isSearchDefined
boolean isSearchDefined()
Returns true if the search object was previously created usinggetSearchObject()
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.
- Since:
- MicroStrategy Web 8.0.0
-
cancelRequest
boolean cancelRequest()
Cancels the current search request. This call purges the search object if possible.- Returns:
- true if successfully cancelled.
-
setFilter
void setFilter(WebObjectFilter value)
- Since:
- MicroStrategy Web 9.0.0
-
getFilter
WebObjectFilter getFilter()
- Since:
- MicroStrategy Web 9.0.0
-
setIgnoreAccessDenialError
void setIgnoreAccessDenialError(boolean ignoreAccessDenialError)
-
setBlockBeginReset
void setBlockBeginReset(boolean isReset)
Set whether current folder bean's blockBegin is reset.
-
isBlockBeginReset
boolean isBlockBeginReset()
Get whether current folder bean's blockBegin is reset.
-
-