Package com.microstrategy.web.app.beans

Class AggregatedFolderEventHandler

java.lang.Object

com.microstrategy.web.beans.GenericEventHandler

com.microstrategy.web.beans.AggregatedEventHandler

com.microstrategy.web.app.beans.AggregatedFolderEventHandler

All Implemented Interfaces:

EnumFolderBeanEvents, EnumObjectBeanEvents, WebEventHandler, WebEventTags, java.lang.Cloneable

public class AggregatedFolderEventHandler
extends AggregatedEventHandler
implements EnumFolderBeanEvents

This aggregated event handler intercepts the browse requests and analyzes if Shared Reports is being requested (with sysFolderId value defined as 7). If so, then it will check for the Administrator Preference where another folder can be selected as Shared Reports. If the Shared Reports has been customized, then this folder will be the one opened, instead of the regular Public Objects > Reports. If users would like to still have the default Shared Reports opened, then specifying the folder ID for it will be required.

Since:

MicroStrategy Web 8.0.1

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler

GenericEventHandler.GenericEventKeys

Field Summary

Fields inherited from class com.microstrategy.web.beans.AggregatedEventHandler

defaultHandler

Fields inherited from class com.microstrategy.web.beans.GenericEventHandler

_extraEvents, layerOfHandleRequest, MULTIPLE_EVENT_SOURCE_SUFFIX, NO_EVENT_ID

Fields inherited from interface com.microstrategy.web.beans.EnumFolderBeanEvents

FOLDER_EVENT_ARGUMENT_BLOCK_BEGIN, FOLDER_EVENT_ARGUMENT_BLOCK_COUNT, FOLDER_EVENT_ARGUMENT_DELETE_OBJECT_TYPE, FOLDER_EVENT_ARGUMENT_DONT_OPEN_NEW_FOLDER, FOLDER_EVENT_ARGUMENT_FOLDER_DESCRIPTION, FOLDER_EVENT_ARGUMENT_FOLDER_ID, FOLDER_EVENT_ARGUMENT_FOLDER_NAME, FOLDER_EVENT_ARGUMENT_LEVEL, FOLDER_EVENT_ARGUMENT_REFRESH, FOLDER_EVENT_ARGUMENT_SEARCH_CREATED, FOLDER_EVENT_ARGUMENT_SEARCH_DATA_SOURCES, FOLDER_EVENT_ARGUMENT_SEARCH_DATE_SUBTYPE, FOLDER_EVENT_ARGUMENT_SEARCH_DATE_TYPE, FOLDER_EVENT_ARGUMENT_SEARCH_DEREFRENCE_SHORTCUT, FOLDER_EVENT_ARGUMENT_SEARCH_DESCRIPTION, FOLDER_EVENT_ARGUMENT_SEARCH_DOMAIN, FOLDER_EVENT_ARGUMENT_SEARCH_END_DATE, FOLDER_EVENT_ARGUMENT_SEARCH_EXCLUDE_FOLDERS, FOLDER_EVENT_ARGUMENT_SEARCH_FIELDS, FOLDER_EVENT_ARGUMENT_SEARCH_FOLDER_BROWSE_STYLE, FOLDER_EVENT_ARGUMENT_SEARCH_ID, FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_UNIT, FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_VALUE, FOLDER_EVENT_ARGUMENT_SEARCH_MAXOBJECTS, FOLDER_EVENT_ARGUMENT_SEARCH_NAME, FOLDER_EVENT_ARGUMENT_SEARCH_OBJECT_TYPE, FOLDER_EVENT_ARGUMENT_SEARCH_OWNER_TYPE, FOLDER_EVENT_ARGUMENT_SEARCH_QUICK_SEARCH, FOLDER_EVENT_ARGUMENT_SEARCH_RECURSE, FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_ID, FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_TYPE, FOLDER_EVENT_ARGUMENT_SEARCH_START_DATE, FOLDER_EVENT_ARGUMENT_SEARCH_USE_PREVIOUS_ROOT_FOLDER, FOLDER_EVENT_ARGUMENT_SEARCH_USES, FOLDER_EVENT_ARGUMENT_SEARCH_WILDCARDS, FOLDER_EVENT_ARGUMENT_SYS_FOLDER, FOLDER_EVENT_BROWSE, FOLDER_EVENT_BROWSE_PARENT_FOLDER, FOLDER_EVENT_CANCEL_REQUEST, FOLDER_EVENT_CREATE_CHILD_FOLDER, FOLDER_EVENT_DELETE_CHILD, FOLDER_EVENT_RENAME_OBJECT, FOLDER_EVENT_SEARCH, FOLDERID_SEPARATOR

Fields inherited from interface com.microstrategy.web.beans.EnumObjectBeanEvents

OBJECT_EVENT_ARGUMENT_FlAGS, OBJECT_EVENT_ARGUMENT_OBJECT_ID, OBJECT_EVENT_ARGUMENT_OBJECT_NAME, OBJECT_EVENT_ARGUMENT_OBJECT_SUBTYPE, OBJECT_EVENT_ARGUMENT_OBJECT_TYPE, OBJECT_EVENT_BROWSE

Fields inherited from interface com.microstrategy.web.beans.WebEventTags

ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS

Constructor Summary

Constructors

Constructor	Description
AggregatedFolderEventHandler()

Method Summary

Modifier and Type	Method	Description
boolean	processRequest(RequestKeys requestKeys)	Constructs an AggregatedFolderEventHandler with the event handler type set to (EnumEventHandlerTypes.HANDLER_TYPE_FOLDER).

Methods inherited from class com.microstrategy.web.beans.AggregatedEventHandler

defaultDelegate, delegateRequest, getDefaultHandler, getHandlerType, getSupportedWebComponentType, getWebEvent, handleDefaultRequest, setDefaultHandler, setHandlerType

Methods inherited from class com.microstrategy.web.beans.GenericEventHandler

addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, getEventID, getEventTarget, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getWebComponent, getWebEvent, getWebEvent, getWebEvents, getWebEventsFromRequest, handleRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, setName, setWebComponent, validateRequiredArgument

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregatedFolderEventHandler

public AggregatedFolderEventHandler()

Method Detail

processRequest

public boolean processRequest(RequestKeys requestKeys)
                       throws WebException

Constructs an AggregatedFolderEventHandler with the event handler type set to (EnumEventHandlerTypes.HANDLER_TYPE_FOLDER).

Specified by:

processRequest in interface WebEventHandler

Specified by:

processRequest in class AggregatedEventHandler

Parameters:

requestKeys - the RequestKeys object containing event ID, sources, and any other information.

Returns:

true if handling succeeds; false if the event is ignored and not handled.

Throws:

WebException - thrown if handling of the request fails.