public class

ServletEvent

extends GenericWebEvent

java.lang.Object
↳	com.microstrategy.web.beans.GenericWebEvent
	↳	com.microstrategy.web.app.beans.ServletEvent

Class Overview

Title: ServletEvent. Description: This class extends the GenericWebEvent by providing a target page. This page is configured in the appBeanEvents.xml Company: MicroStrategy

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.beans.WebEventTags

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.GenericWebEvent

Public Constructors
	ServletEvent() Just calls super()

Public Methods
void	addEventInfo(ParameterBuilder paramBldr, int eventElements, int howMuchChildState) Adds event information into an existing `ParameterBuilder` instance.
RequestKeys	getRequestKeys() Returns a reference to the `RequestKeys` associated wih the event
String	getSourcePath() Extends getSourcePath by returning the path of the Source element as found in the RequestKeys.
String	getTargetPage() Returns the page the execution will be redirected to when the event is handled
boolean	initFromRequest(RequestKeys keys) Initialize the event with the given request keys
boolean	initFromXML(Element node) This method is deprecated. The ServletEventHandler is not responsible to read the xml structure.
void	setID(int id) Extends setID by filtering the request keys to use only the event and source of the given event id.
void	setTargetPage(String page) Sets the page the execution will be redirected to when the event is handled

Protected Methods
void	init(EventInfo info)

[Expand]

Inherited Methods

From class com.microstrategy.web.beans.GenericWebEvent

static boolean	areAllBitsSet(int intVal, int bits) Returns whether all the specified bits in intVal are set.
Object	clone() Clone the current `WebEvent`.
String	getArgumentName(int id) Returns the argument name with the specified `id` at index 0.
String	getArgumentName(int id, int index) Returns the argument name with the specified `id` at the specified `index`.
String	getArgumentValue(int argumentID) Returns the current value of the argument.
String	getArgumentValue(int argumentID, int index) Returns the current value of the argument.
int	getArgumentValueCount(int argumentID) Returns the number of values at different indices for the argument.
Enumeration	getArguments() Returns an Enumeration over all the `WebEvent.Argument` in this `WebEvent`.
String	getDeprecatedMessage() Returns the deprecation message.
String	getFlatState() `FlatStateSerializer` representation of event.
int	getHandlerType() Returns the type of the `WebEventHandler` by which this event is supported.
String	getHiddenInputs(int paramType, int howMuchChildState) This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
int	getID() Returns the event id of the current `WebEvent`.
String	getName() Returns the name of the current `WebEvent`.
WebComponent	getSource() Returns the event source, a `WebComponent` object which knows how to generate and handle this event.
String	getSourcePath() Returns the path of a `WebComponent` which knows how to generate and handle this WebEvent.
String	getTargetWindow() returns the target specified for this event
String	getURLLink(int paramType) This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
String	getURLLink() This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
String	getURLParameters(int paramType) This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
String	getURLParameters() This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
String	getURLParameters(int paramType, int howMuchChildState) This method is deprecated. Replaced by `addEventInfo(WebEvent, int, int)`.
void	init(EventInfo info)
void	initFromKeys(RequestKeys keys) Initialize the event with the given request keys
boolean	initFromXML(String xml) This method is deprecated. GenericWebEvent is not responsible for parsing the xml from the events-definition, instead use the `EventHandlersCatalog` to parse the XML and create this instance passing an `EventInfo` class as part of the constructor.
boolean	initFromXML(Element node) This method is deprecated. GenericWebEvent is not responsible for parsing the xml from the events-definition, instead use the `EventHandlersCatalog` to parse the XML and create this instance passing an `EventInfo` class as part of the constructor.
static boolean	isAnyBitSet(int intVal, int bits) Returns whether any of the specified bits in intVal are set.
void	putArgument(int id, String name, String value)
void	putArgument(int id, String name)
void	putArgument(int id, String name, int required)
void	setArgumentValue(int id, String value) Sets a value to the argument with the specified `id` at index 0.
void	setArgumentValue(int id, int index, String value) Sets a value to the argument with the specified `id` at the specified `index`.
void	setDeprecationMessage(String message) Sets a deprecation message.
void	setHandlerType(int type) Sets the type of the `WebEventHandler` by which this event is supported.
void	setID(int id) Sets an event id to the current `WebEvent`.
void	setName(String name) Sets a name to the current `WebEvent`.
void	setSource(WebComponent source) Sets a `WebComponent` instance which knows how to generate and handle this WebEvent.
void	setSourcePath(String source) Sets the path of a `WebComponent` which knows how to generate and handle this WebEvent.
void	setTargetWindow(String target) Sets the target attribute for this event.
String	toString()
void	validateRequiredArguments() Checks to see if all the required arguments specified have an argument, if not, an `IllegalArgumentException` is thrown.

From class java.lang.Object

From interface com.microstrategy.web.beans.WebEvent

Public Constructors

public ServletEvent ()

Just calls super()

Public Methods

public void addEventInfo (ParameterBuilder paramBldr, int eventElements, int howMuchChildState)

Adds event information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Extends addEventInfo by automatically setting the value of the arguments if the Event has been initialized with a RequestKeys.
If the value of any of the Arguments of this event is found in the request, it will will automatically take that value.

Parameters

paramBldr	The `ParameterBuilder` instance which has child state information added to it.
eventElements	A bit mask value composed of constants from `EnumEventElement`. These determine what elements of the event is added.
howMuchChildState	If children state is to be added, this parameter (whose values come from `EnumWebPersistableState`) determines how much state.

public RequestKeys getRequestKeys ()

Returns a reference to the RequestKeys associated wih the event

Returns

RequestKeys

public String getSourcePath ()

Extends getSourcePath by returning the path of the Source element as found in the RequestKeys.
If the SourcePath has not been specifically set for this event (by calling setSourcePath(), and if this Event has been initialized with a RequestKeys, then the event checks if the RequestKeys contains the URL_SOURCE_NAME and if so return it as the SourcePath.

Returns

the path to the WebComponent source of this event.

public String getTargetPage ()

Returns the page the execution will be redirected to when the event is handled

Returns

String the name of the page. This page should exist in the pageConfig.xml file

public boolean initFromRequest (RequestKeys keys)

Initialize the event with the given request keys

Parameters

keys	the request keys to be used by this event

Returns

true

public boolean initFromXML (Element node)

This method is deprecated.
The ServletEventHandler is not responsible to read the xml structure.

Extendes initFromXml by reading a target attribute. If this node doesn't have a target attribute it returns false

Parameters

node	the xmlNode with the event information

Returns

true if the node contains valid information. false otherwise

public void setID (int id)

Extends setID by filtering the request keys to use only the event and source of the given event id.

Parameters

id	an event id to set.

public void setTargetPage (String page)

Sets the page the execution will be redirected to when the event is handled

Parameters

page	a valid page name defined in the pageConfig.xml file

Interfaces

Classes

Exceptions

ServletEvent

Class Overview

Summary

Public Constructors

public ServletEvent ()

Public Methods

public void addEventInfo (ParameterBuilder paramBldr, int eventElements, int howMuchChildState)

Parameters

public RequestKeys getRequestKeys ()

Returns

public String getSourcePath ()

Returns

public String getTargetPage ()

Returns

public boolean initFromRequest (RequestKeys keys)

Parameters

Returns

public boolean initFromXML (Element node)

Parameters

Returns

public void setID (int id)

Parameters

public void setTargetPage (String page)

Parameters

Protected Methods

protected void init (EventInfo info)