public class

EventHandlerInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.beans.EventHandlerInfo

Class Overview

This class represents the "eventHandler" node from the XML. Each event handler is identified by its type. Children : The events node which holds the list of all the events. Attributes: "type" - The event handler type "name" - The name of the event handler Key : "type" attribute.

Summary

Constants
String ATT_NAME
String ATT_TYPE
String NODE_EVENT_HANDLER
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
EventHandlerInfo()
Default constructor.
EventHandlerInfo(int type)
Constructor: Set the type field for the event handler
EventHandlerInfo(int type, String name)
Constructor: Set the "type" and "name" field for this event handler
Public Methods
void deleteEvent(int id)
Delete the event with the given id.
EventInfo getEvent(int eventID)
Return the event with the given id from the events list
EventInfoList getEventsList()
Return the list of events associated with this event handler
String getName()
Return the name field value
int getType()
Return the type field value
EventInfo newEvent(int id)
Create a new event and add it to the events list.
void setName(String name)
Set the name field value
void setType(int type)
Set the type field value
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_TYPE

Constant Value: "type"

public static final String NODE_EVENT_HANDLER

Constant Value: "eventHandler"

Public Constructors

public EventHandlerInfo ()

Default constructor. Set the node name and register the child element

public EventHandlerInfo (int type)

Constructor: Set the type field for the event handler

Parameters
type The event handler "type" for this object

public EventHandlerInfo (int type, String name)

Constructor: Set the "type" and "name" field for this event handler

Parameters
type The event handler "type" for this object
name The event handler "name" for this object

Public Methods

public void deleteEvent (int id)

Delete the event with the given id. This is a shortcut method to EventInfoList#deleteEvent()

Parameters
id The id of the event to be deleted

public EventInfo getEvent (int eventID)

Return the event with the given id from the events list

Parameters
eventID The id for the event to be returned
Returns
  • The event with the given id

public EventInfoList getEventsList ()

Return the list of events associated with this event handler

Returns
  • The events list for this handler

public String getName ()

Return the name field value

Returns
  • The "name" associated with this event handler

public int getType ()

Return the type field value

Returns
  • The "type" associated with this event handler

public EventInfo newEvent (int id)

Create a new event and add it to the events list. This is a shortcut method to EventInfoList#newEvent()

Parameters
id The id (key) for the new event to be created
Returns
  • The new event created and added to the list with the given id

public void setName (String name)

Set the name field value

Parameters
name The new value for the "name" attribute

public void setType (int type)

Set the type field value

Parameters
type The new value for the "type" attribute

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.