AggregatedFolderEventHandler

Class Overview

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.

Summary

[Expand] Inherited Constants
From class com.microstrategy.web.beans.GenericEventHandler String MULTIPLE_EVENT_SOURCE_SUFFIX int NO_EVENT_ID This constant represents the ID returned by the getEventID method when there is no event in the request
From interface com.microstrategy.web.beans.EnumFolderBeanEvents String FOLDERID_SEPARATOR int FOLDER_EVENT_ARGUMENT_BLOCK_BEGIN Specifies the blockBegin property for incremental fetch. int FOLDER_EVENT_ARGUMENT_BLOCK_COUNT Specifies the blockCount property for incremental fetch. int FOLDER_EVENT_ARGUMENT_DELETE_OBJECT_TYPE Specifies the types of the object to delete. int FOLDER_EVENT_ARGUMENT_DONT_OPEN_NEW_FOLDER Specifies not to open a new folder int FOLDER_EVENT_ARGUMENT_FOLDER_DESCRIPTION argument specifying the description of the created child folder. int FOLDER_EVENT_ARGUMENT_FOLDER_ID Specifies the object ID of a WebFolder. int FOLDER_EVENT_ARGUMENT_FOLDER_NAME argument specifying the name of the created child folder. int FOLDER_EVENT_ARGUMENT_LEVEL Specifies the level property when populating a folder object from the Intelligence Server. int FOLDER_EVENT_ARGUMENT_REFRESH Specifies to refresh when browsing a folder int FOLDER_EVENT_ARGUMENT_SEARCH_CREATED Specifies if the search should be restricted based on dates taken from the creation time. int FOLDER_EVENT_ARGUMENT_SEARCH_DATA_SOURCES Specifies to use the data sources parameter for the search. int FOLDER_EVENT_ARGUMENT_SEARCH_DATE_SUBTYPE Specifies if the search should be restricted based on dates on a time or date interval. int FOLDER_EVENT_ARGUMENT_SEARCH_DATE_TYPE Specifies if the search should be restricted based on the date. int FOLDER_EVENT_ARGUMENT_SEARCH_DEREFRENCE_SHORTCUT Specifies whether to set the DssXmlSearchDereferenceShortcut flag on int FOLDER_EVENT_ARGUMENT_SEARCH_DESCRIPTION Specifies to restrict the search based on some text found in the description. int FOLDER_EVENT_ARGUMENT_SEARCH_DOMAIN Specifies an integer value for the search domain. int FOLDER_EVENT_ARGUMENT_SEARCH_END_DATE Specifies the ending date when a search is restricted based on a date interval. int FOLDER_EVENT_ARGUMENT_SEARCH_EXCLUDE_FOLDERS Specifies to the folders to be excluded when searching. int FOLDER_EVENT_ARGUMENT_SEARCH_FIELDS Specifies what fields to search on object int FOLDER_EVENT_ARGUMENT_SEARCH_FOLDER_BROWSE_STYLE Specifies whether to get search result as folder browse style. int FOLDER_EVENT_ARGUMENT_SEARCH_ID Specifies the ID of the search to use. int FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_UNIT Specifies the time units when a search is restricted based on a time interval. int FOLDER_EVENT_ARGUMENT_SEARCH_INTERVAL_VALUE Specifies the time value when a search is restricted based on a time interval. int FOLDER_EVENT_ARGUMENT_SEARCH_MAXOBJECTS Specifies whether the search should return a maximum number of objects. int FOLDER_EVENT_ARGUMENT_SEARCH_NAME Specifies the text that the name should include in the search. int FOLDER_EVENT_ARGUMENT_SEARCH_OBJECT_TYPE Specifies the types of the objects to search. int FOLDER_EVENT_ARGUMENT_SEARCH_OWNER_TYPE Specifies the owner of the object to search. int FOLDER_EVENT_ARGUMENT_SEARCH_QUICK_SEARCH Specifies whether to use new search engine int FOLDER_EVENT_ARGUMENT_SEARCH_RECURSE Specifies whether to recurse into the subfolders during a search operation. int FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_ID Specifies the ID of the root folder. int FOLDER_EVENT_ARGUMENT_SEARCH_ROOT_FOLDER_TYPE Specifies the type of the root folder. int FOLDER_EVENT_ARGUMENT_SEARCH_START_DATE Specifies the starting date when a search is restriscted based on a date interval. int FOLDER_EVENT_ARGUMENT_SEARCH_USES Specifies what fields to search on object int FOLDER_EVENT_ARGUMENT_SEARCH_USE_PREVIOUS_ROOT_FOLDER Specifies whether to use the previous search root if the root folder is not specified as an argument. int FOLDER_EVENT_ARGUMENT_SEARCH_WILDCARDS Specifies whether the search will include wildcards. int FOLDER_EVENT_ARGUMENT_SYS_FOLDER Specifies the system folder to browse into. int FOLDER_EVENT_BROWSE event for browsing a given folder. int FOLDER_EVENT_BROWSE_PARENT_FOLDER event for browsing the parent folder. int FOLDER_EVENT_CANCEL_REQUEST event for canceling the request. int FOLDER_EVENT_CREATE_CHILD_FOLDER event for creating a child folder under the current folder. int FOLDER_EVENT_DELETE_CHILD event for delete objects. int FOLDER_EVENT_RENAME_OBJECT event for rename the folder itself or its child int FOLDER_EVENT_SEARCH event for searching a given object.
From interface com.microstrategy.web.beans.EnumObjectBeanEvents int OBJECT_EVENT_ARGUMENT_FlAGS flags -- integer argument specifying the flags (from EnumDSSXMLObjectFlags ) to be used while performing object browse operations. int OBJECT_EVENT_ARGUMENT_OBJECT_ID objectID -- argument using for browsing objects. int OBJECT_EVENT_ARGUMENT_OBJECT_NAME objectName int OBJECT_EVENT_ARGUMENT_OBJECT_SUBTYPE int OBJECT_EVENT_ARGUMENT_OBJECT_TYPE objectType -- argument using for browsing objects. int OBJECT_EVENT_BROWSE event for browsing a given object.
From interface com.microstrategy.web.beans.WebEventTags String ATT_ARGUMENT_ENUMERATOR The enumeration value for event argument id. String ATT_ARGUMENT_ID The id attribute of the XML tag event argument String ATT_ARGUMENT_INDEX The index attribute of the XML tag event argument String ATT_ARGUMENT_NAME The name attribute of the XML tag event argument String ATT_ARGUMENT_REQUIRED The required attribute of the XML tag event argument String ATT_ARGUMENT_TYPE The type attribute of the XML tag event argument String ATT_ARGUMENT_VALIDATOR The validator attribute of the XML tag event argument String ATT_ARGUMENT_VALUE The value attribute of the XML tag event argument String ATT_EVENT_DEPRECATED Attribute marking the event as deprecated. String ATT_EVENT_ENUMERATOR The enumeration value for event id. String ATT_EVENT_HANDLER_ENUMERATOR The enumeration value for event handler type. String ATT_EVENT_HANDLER_NAME The name attribute of the XML tag eventHandler String ATT_EVENT_HANDLER_TYPE The type attribute of the XML tag eventHandler String ATT_EVENT_ID The id attribute of the XML tag event String ATT_EVENT_NAME The name attribute of the XML tag event String ATT_EVENT_TARGET The name attribute of the XML tag event String TAG_ARGUMENT The XML tags for event argument String TAG_ARGUMENTS The XML tags for event arguments String TAG_EVENT The XML tags for event String TAG_EVENTS The XML tags for events String TAG_EVENT_HANDLER The XML tags for event_handler String TAG_EVENT_HANDLERS The XML tags for event_handlers

[Expand] Inherited Fields
From class com.microstrategy.web.beans.AggregatedEventHandler protected WebEventHandler defaultHandler The default event handler.
From class com.microstrategy.web.beans.GenericEventHandler protected List<WebEvent> _extraEvents protected int layerOfHandleRequest

[Expand] Inherited Methods
From class com.microstrategy.web.beans.AggregatedEventHandler boolean defaultDelegate(RequestKeys keys) boolean delegateRequest(RequestKeys keys) The default implementation of this method simply delegates the event to the next source component specified in the static field GenericWebEvent.URL_SOURCE_NAME. WebEventHandler getDefaultHandler() Returns the default event handler. int getHandlerType() Returns the event handler type. Class getSupportedWebComponentType() Returns the Class type of the WebComponent this event handler is associated with. WebEvent getWebEvent(int id) Returns the specified WebEvent instance which this event handler supports. boolean handleDefaultRequest(RequestKeys keys) Asks the default event handler to handle the request. abstract boolean processRequest(RequestKeys keys) This method encapsulates the logic to process an incoming event. void setDefaultHandler(WebEventHandler handler) Sets the default event handler. void setHandlerType(int type) Sets the event handler type.
From class com.microstrategy.web.beans.GenericEventHandler void addEvent(WebEvent event) Adds a WebEvent instance into the current event handler. void addEvent(Element eventNode) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor void addEvents(Element node) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor static void addEventsFromRequestKeys(ArrayList eventList, RequestKeys keys, WebComponent component, SimpleList filterEventIDList) void addEventsFromXML(String eventsXML) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor void appendRemainingEvent(WebEvent event) Append an remaining event at the end of the remaining events' list. Object clone() Clone the current event handler instance. boolean delegateRequest(RequestKeys keys) The default implementation of this method simply delegates the event to the next source component specified in the static field GenericWebEvent.URL_SOURCE_NAME. static int getEventID(RequestKeys keys) Retrieves the event id passed in from the RequestKeys. WebComponent getEventTarget(RequestKeys keys) int getHandlerType() Returns the type of the current WebEventHandle. String getName() Returns the name of this event handler String getNextSourceName(RequestKeys keys) Returns the next component name in the event component path. static String getNextSourceName(String currentBeanPath, String eventFullPath) Returns the next source component which will handle the event. static SimpleList getOrderedEvents(RequestKeys keys, String errorDesc) SimpleList getPendingEvents() Returns the list of events that were not processed. Class getSupportedWebComponentType() Returns the WebComponent class by default. WebComponent getWebComponent() Returns the WebComponent object associated with the current event handler. WebEvent getWebEvent(RequestKeys keys) Decodes the WebEvent from the RequestKeys. WebEvent getWebEvent(int eventID, RequestKeys keys) This method should be used when the eventID passed in is different from the one that is included as a value in the keys parameter WebEvent getWebEvent(int eventID) Returns the specified WebEvent instance which this event handler supports. Enumeration getWebEvents() Returns an enumeration over the WebEvent suppored by this event handler. Enumeration getWebEventsFromRequest(RequestKeys keys) Returns an enumeration over the WebEvent suppored by this event handler that are present in the request keys provided. boolean handleRequest(RequestKeys keys) Handles the WebEvent specified in the RequestKeys object. boolean isInitialized() Returns true after the markInitailized() has been called. boolean isMyEvent(RequestKeys keys) void markInitailized() Call this method to mark this event-handler instance as initialized. void processExtraEvents() static void processMultipleEvents(String flatState, MultipleEventHandler handler, String componentPath) Processes multiple events encoded via the FlatStateSerializer. static void processMultipleEvents(String flatState, MultipleEventHandler handler) This method is deprecated. Use processMultipleEvents(String, MultipleEventHandler, String) boolean processRequest(RequestKeys keys) Logic to process the event. void setHandlerType(int type) Sets the type of the current event handler. void setName(String name) Sets the name to this event handler void setWebComponent(WebComponent component) Sets a WebComponent instance on this event handler. void validateRequiredArgument(String argName, String argValue) A helper method which ensures that the argValue corresponding to argName is not null and not empty.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.beans.WebEventHandler abstract void addEvent(WebEvent event) Adds WebEvent into the current event handler. abstract void addEventsFromXML(String eventsXML) Adds one or more WebEvent into the current event handler. abstract void appendRemainingEvent(WebEvent event) Append an remaining event at the end of the remaining events' list. abstract boolean delegateRequest(RequestKeys keys) This method encapsulates the mechanism by which a request is delegated to child WebComponents. abstract int getHandlerType() Returns the type of the current WebEventHandle. abstract SimpleList getPendingEvents() Returns the list of events that were not processed. abstract Class getSupportedWebComponentType() Returns the Class type of the WebComponent this event handler is associated with. abstract WebComponent getWebComponent() Returns the WebComponent object associated with the current event handler. abstract WebEvent getWebEvent(int eventID) Returns the specified WebEvent instance which this event handler supports. abstract Enumeration getWebEvents() Returns an enumeration over the WebEvent objects suppored by this event handler. abstract Enumeration getWebEventsFromRequest(RequestKeys keys) Returns an enumeration over the WebEvent suppored by this event handler that are present in the request keys provided. abstract boolean handleRequest(RequestKeys keys) Handles the WebEvent specified in the RequestKeys object. abstract boolean processRequest(RequestKeys keys) This method encapsulates the logic to process incoming events without regard as to how it was triggered or be concerned with delegation the request (see processRequest(RequestKeys)). abstract void setWebComponent(WebComponent component) Sets a WebComponent instance on this WebEventHandler.