Package com.microstrategy.web.beans
Class AttributeEventHandler
- java.lang.Object
-
- com.microstrategy.web.beans.GenericEventHandler
-
- com.microstrategy.web.beans.SysEventHandler
-
- com.microstrategy.web.beans.AttributeEventHandler
-
- All Implemented Interfaces:
EnumAttributeBeanEvents
,EnumObjectBeanEvents
,WebEventHandler
,WebEventTags
,java.lang.Cloneable
public class AttributeEventHandler extends SysEventHandler implements EnumAttributeBeanEvents
- Since:
- MicroStrategy Web 9.0.0
-
-
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.SysEventHandler
DEFAULT_CONFIG_PATH
-
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.EnumAttributeBeanEvents
ATTRIBUTE_EVENT_ARGUMENT_ATTRIBUTE_ID, ATTRIBUTE_EVENT_ARGUMENT_BLOCK_BEGIN, ATTRIBUTE_EVENT_ARGUMENT_BLOCK_COUNT, ATTRIBUTE_EVENT_ARGUMENT_BROWSE_PATH_XML, ATTRIBUTE_EVENT_ARGUMENT_CLIENT_FORM_PATTERNS, ATTRIBUTE_EVENT_ARGUMENT_COLLECT_FORMS, ATTRIBUTE_EVENT_ARGUMENT_CONTOL_KEY, ATTRIBUTE_EVENT_ARGUMENT_DATASET_ID, ATTRIBUTE_EVENT_ARGUMENT_DATASOURCES_XML, ATTRIBUTE_EVENT_ARGUMENT_DIMENSION_ID, ATTRIBUTE_EVENT_ARGUMENT_EXPRESSION_XML, ATTRIBUTE_EVENT_ARGUMENT_FILTER_XML, ATTRIBUTE_EVENT_ARGUMENT_MESSAGE_ID, ATTRIBUTE_EVENT_ARGUMENT_RAW_INPUT, ATTRIBUTE_EVENT_ARGUMENT_SEARCH_FORMS, ATTRIBUTE_EVENT_ARGUMENT_SEARCH_MATCH_CASE, ATTRIBUTE_EVENT_ARGUMENT_SEARCH_PATTERN, ATTRIBUTE_EVENT_ARGUMENT_SHORT_FILTER_XML, ATTRIBUTE_EVENT_ARGUMENT_TEMPLATE_NODE_KEY, ATTRIBUTE_EVENT_ARGUMENT_USE_BROWSE_FORM, ATTRIBUTE_EVENT_BROWSE, FORM_LIST_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 AttributeEventHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected WebInboxSource
getInboxSource()
protected WebObjectInfo
getObject(java.lang.String id, int type)
protected WebObjectInfo
getObject(java.lang.String id, int type, int subType)
protected WebObjectsFactory
getObjectsFactory()
protected WebObjectSource
getObjectSource()
protected void
initEvents()
This method is called to initialize the list of events available with this event-handler.boolean
processRequest(RequestKeys keys)
Logic to process the event.protected void
setObjectBean(ObjectBean ob)
-
Methods inherited from class com.microstrategy.web.beans.SysEventHandler
getCatalog, getWebEvent, getWebEvents, initEvents, newDefaultEventInstance, newWebEvent
-
Methods inherited from class com.microstrategy.web.beans.GenericEventHandler
addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, delegateRequest, getEventID, getEventTarget, getHandlerType, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getSupportedWebComponentType, getWebComponent, getWebEvent, getWebEvent, getWebEventsFromRequest, handleRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, setHandlerType, setName, setWebComponent, validateRequiredArgument
-
-
-
-
Method Detail
-
processRequest
public boolean processRequest(RequestKeys keys) throws WebException
Description copied from class:GenericEventHandler
Logic to process the event. Specific event handler implementation extending this class will need to override the default behavior.- Specified by:
processRequest
in interfaceWebEventHandler
- Parameters:
keys
- 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.
-
getObjectsFactory
protected WebObjectsFactory getObjectsFactory() throws java.lang.IllegalStateException
- Throws:
java.lang.IllegalStateException
-
getObjectSource
protected WebObjectSource getObjectSource()
-
getObject
protected WebObjectInfo getObject(java.lang.String id, int type) throws WebObjectsException
- Throws:
WebObjectsException
-
getObject
protected WebObjectInfo getObject(java.lang.String id, int type, int subType) throws WebObjectsException
- Throws:
WebObjectsException
-
setObjectBean
protected void setObjectBean(ObjectBean ob)
-
getInboxSource
protected WebInboxSource getInboxSource()
-
initEvents
protected void initEvents()
Description copied from class:SysEventHandler
This method is called to initialize the list of events available with this event-handler. Since this class uses lazy initialization for its event list; this method will be always called by the
Those event-handler that support more than one handler-type can extend this method and callSysEventHandler.getWebEvent(int)
and theSysEventHandler.getWebEvents()
methods to ensure it's available. If the list has been initialized, it does nothing, if not it callsSysEventHandler.initEvents(int type)
passing this handler's typeSysEventHandler.initEvents(int type)
with all the types they support.- Overrides:
initEvents
in classSysEventHandler
-
-