Supported Bean: FolderBean
ObjectBean
supports the concept of object browsing. It specializes the
ObjectBean in the following ways:
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.
FolderBean.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.
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_FOLDER (2)
Events
| browseEvent | ||||
| event for browsing a given object. |
1001 | |||
|
*objectID | objectID -- argument using for browsing objects. |
1001 | ||
|
executionFlags | flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing
object browse operations. |
1003 | ||
| browseEvent | ||||
| event for browsing a given folder. |
2001 | |||
|
executionFlags | flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing
object browse operations. |
1003 | ||
|
folderBlockBegin | Specifies the blockBegin property for incremental fetch. |
2002 | ||
|
folderBlockCount | Specifies the blockCount property for incremental fetch. |
2003 | ||
|
folderID | objectID -- argument using for browsing objects. |
1001 | ||
|
folderName | objectName |
1004 | ||
|
refresh | Specifies to refresh when browsing a folder |
2030 | ||
|
systemFolder | Specifies the system folder to browse into. |
2023 | ||
| browseParentEvent | ||||
| event for browsing the parent folder. |
2006 | |||
| cancelRequestEvent | ||||
| event for canceling the request. |
2005 | |||
| createChildFolder | ||||
| event for creating a child folder under the current folder. |
2002 | |||
|
*childFolderName | argument specifying the name of the created child folder. |
2005 | ||
|
childFolderDescription | argument specifying the description of the created child folder. |
2006 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_DESCRIPTION |
|
|
dontOpenNewFolder | Specifies not to open a new folder |
2025 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_DONT_OPEN_NEW_FOLDER |
|
| deleteEvent | ||||
| event for delete objects. |
2004 | |||
|
*objectID | objectID -- argument using for browsing objects. |
1001 | ||
|
*objectType | objectType -- argument using for browsing objects. |
1002 | ||
| renameChild | ||||
| event for rename the folder itself or its child |
2007 | |||
|
*objectID | objectID -- argument using for browsing objects. |
1001 | ||
|
*objectType | objectType -- argument using for browsing objects. |
1002 | ||
|
objectName | objectName |
1004 | ||
| searchEvent | ||||
| event for searching a given object. |
2003 | |||
|
created | Specifies if the search should be restricted based on dates taken from the creation time. |
2015 | ||
|
dataSources | Specifies to use the data sources parameter for the search. This typically allows the user to search within the specified data source as opposed to the entire project. |
2029 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_DATA_SOURCES |
|
|
dateSubType | Specifies if the search should be restricted based on dates on a time or date interval. |
2014 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_DATE_SUBTYPE |
|
|
dateType | Specifies if the search should be restricted based on the date. |
2013 | ||
|
dereferenceshortcut | Specifies whether to set the DssXmlSearchDereferenceShortcut flag on |
2032 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_DEREFRENCE_SHORTCUT |
|
|
description | Specifies to restrict the search based on some text found in the description. |
2021 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_DESCRIPTION |
|
|
endDate | Specifies the ending date when a search is restricted based on a date interval. |
2019 | ||
|
excludeFolders | Specifies to the folders to be excluded when searching. |
2031 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_EXCLUDE_FOLDERS |
|
|
fields | Specifies what fields to search on object |
2034 | ||
|
folderBlockBegin | Specifies the blockBegin property for incremental fetch. |
2002 | ||
|
folderBlockCount | Specifies the blockCount property for incremental fetch. |
2003 | ||
|
folderBrowserStyle | Specifies whether to get search result as folder browse style. Set argument to 1 to enable folder browse style. |
2027 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_FOLDER_BROWSE_STYLE |
|
|
folderID | objectID -- argument using for browsing objects. |
1001 | ||
|
intervalUnit | Specifies the time units when a search is restricted based on a time interval. |
2016 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_UNIT |
|
|
intervalValue | Specifies the time value when a search is restricted based on a time interval. |
2017 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_VALUE |
|
|
maxObjects | Specifies whether the search should return a maximum number of objects. |
2022 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_MAXOBJECTS |
|
|
name | Specifies the text that the name should include in the search. |
2008 | ||
|
nameWildcards | Specifies whether the search will include wildcards. |
2009 | ||
|
objectType | Specifies the types of the objects to search. |
2012 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_OBJECT_TYPE |
|
|
ownerType | Specifies the owner of the object to search. |
2020 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_OWNER_TYPE |
|
|
quickSearch | Specifies whether to use new search engine |
2033 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_QUICK_SEARCH |
|
|
recurse | Specifies whether to recurse into the subfolders during a search operation. Set argument to 1 to enable recursion. |
2024 | ||
|
rootFolderID | Specifies the ID of the root folder. |
2010 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_ID |
|
|
rootFolderType | Specifies the type of the root folder. |
2011 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_TYPE |
|
|
searchDomain | Specifies an integer value for the search domain. It defaults to
EnumDSSXMLSearchDomain.DssXmlSearchDomainProject. |
2026 | ||
|
searchID | Specifies the ID of the search to use. |
2007 | ||
|
startDate | Specifies the starting date when a search is restriscted based on a date interval. |
2018 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_START_DATE |
|
|
usePreviousRootFolder | Specifies whether to use the previous search root if the root folder is not specified as an argument. When this parameter is missing, default behavior would be to reset the search root to the root folder of the project, when the root folder is not specified. Passing in "1" will set this flag to true, all other string will set it to false. |
2028 |
EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SEARCH_USE_PREVIOUS_ROOT_FOLDER |
|
|
uses | Specifies what fields to search on object |
2035 | ||
Notes
* denotes required field.