public class

SecurityFilterEventHandler

extends SysEventHandler
implements EnumEditableObjectBeanEvents EnumObjectBeanEvents EnumSecurityFilterBeanEvents

java.lang.Object
↳	com.microstrategy.web.beans.GenericEventHandler
	↳	com.microstrategy.web.beans.SysEventHandler
		↳	com.microstrategy.web.beans.SecurityFilterEventHandler

Class Overview

Title:

Description:

Company: Microstrategy, Inc

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.beans.SysEventHandler

From class com.microstrategy.web.beans.GenericEventHandler

From interface com.microstrategy.web.beans.EnumEditableObjectBeanEvents

From interface com.microstrategy.web.beans.EnumObjectBeanEvents

From interface com.microstrategy.web.beans.EnumSecurityFilterBeanEvents

From interface com.microstrategy.web.beans.WebEventTags

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.GenericEventHandler

Public Constructors
	SecurityFilterEventHandler()

Public Methods
boolean	processRequest(RequestKeys inKeys) Logic to process the event.

Protected Methods
WebInboxSource	getInboxSource()
WebObjectInfo	getObject(String id, int type, int subType)
WebObjectInfo	getObject(String id, int type)
WebObjectSource	getObjectSource()
WebObjectsFactory	getObjectsFactory()
boolean	handleDelete(EditableObjectBean eb)
boolean	handleDuplicate(EditableObjectBean eb) handleDuplicate
boolean	handleNew(EditableObjectBean eb) handleNew
boolean	handleRefresh(EditableObjectBean eb) handleRefresh
boolean	handleSave(EditableObjectBean eb) handleSave
boolean	handleSetName(EditableObjectBean eb, WebEvent event)
void	initEvents() This method is called to initialize the list of events available with this event-handler.
void	setObjectBean(ObjectBean ob)

[Expand]

Inherited Methods

From class com.microstrategy.web.beans.SysEventHandler

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
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.
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(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(RequestKeys keys) Decodes the `WebEvent` from the `RequestKeys`.
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) This method is deprecated. Use `processMultipleEvents(String, MultipleEventHandler, String)`
static void	processMultipleEvents(String flatState, MultipleEventHandler handler, String componentPath) Processes multiple events encoded via the `FlatStateSerializer`.
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

From interface com.microstrategy.web.beans.WebEventHandler

Public Constructors

public SecurityFilterEventHandler ()

Public Methods

public boolean processRequest (RequestKeys inKeys)

Logic to process the event. Specific event handler implementation extending this class will need to override the default behavior.

Parameters

inKeys	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

Protected Methods

protected WebInboxSource getInboxSource ()

protected WebObjectInfo getObject (String id, int type, int subType)

Throws

WebObjectsException

protected WebObjectInfo getObject (String id, int type)

Throws

WebObjectsException

protected WebObjectSource getObjectSource ()

protected WebObjectsFactory getObjectsFactory ()

Throws

IllegalStateException

protected boolean handleDelete (EditableObjectBean eb)

Throws

WebBeanException

protected boolean handleDuplicate (EditableObjectBean eb)

handleDuplicate

Returns

boolean

Throws

WebBeanException

protected boolean handleNew (EditableObjectBean eb)

handleNew

Returns

boolean

protected boolean handleRefresh (EditableObjectBean eb)

handleRefresh

Returns

boolean

Throws

WebBeanException

protected boolean handleSave (EditableObjectBean eb)

handleSave

Returns

boolean

Throws

WebBeanException

protected boolean handleSetName (EditableObjectBean eb, WebEvent event)

Throws

WebBeanException

protected void initEvents ()

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 getWebEvent(RequestKeys) and the getWebEvents() methods to ensure it's available. If the list has been initialized, it does nothing, if not it calls initEvents(int) passing this handler's type

Those event-handler that support more than one handler-type can extend this method and call initEvents(int) with all the types they support.

Interfaces

Classes

Exceptions

SecurityFilterEventHandler

Class Overview

Summary

Public Constructors

public SecurityFilterEventHandler ()

Public Methods

public boolean processRequest (RequestKeys inKeys)

Parameters

Returns

Throws

Protected Methods

protected WebInboxSource getInboxSource ()

protected WebObjectInfo getObject (String id, int type, int subType)

Throws

protected WebObjectInfo getObject (String id, int type)

Throws

protected WebObjectSource getObjectSource ()

protected WebObjectsFactory getObjectsFactory ()

Throws

protected boolean handleDelete (EditableObjectBean eb)

Throws

protected boolean handleDuplicate (EditableObjectBean eb)

Returns

Throws

protected boolean handleNew (EditableObjectBean eb)

Returns

protected boolean handleRefresh (EditableObjectBean eb)

Returns

Throws

protected boolean handleSave (EditableObjectBean eb)

Returns

Throws

protected boolean handleSetName (EditableObjectBean eb, WebEvent event)

Throws

protected void initEvents ()

protected void setObjectBean (ObjectBean ob)