public class

EventInfoList

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

Class Overview

This class represents the "events" node from the XML. It contains a list of all the events associated with the event handler. Children : The list of all the events. Attributes: none Key : null.

Summary

Constants
String NODE_EVENTS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
EventInfoList()
Default Constructor.
Public Methods
void deleteEvent(int id)
Delete the event with the given id
EventInfo getEvent(int eventID)
Return the event which has the given id
EventInfo newEvent(int id)
Create a new event and add it to the events list
Protected Methods
Class getListClass()
Returns the Class items beloging to this list will be instance of.
String getListNodeName()
Returns the name of the node representing children of this list.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractElementList
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 NODE_EVENTS

Constant Value: "events"

Public Constructors

public EventInfoList ()

Default Constructor. Set the name of the node as defined in the xml.

Public Methods

public void deleteEvent (int id)

Delete the event with the given id

Parameters
id The id of the event to be deleted

public EventInfo getEvent (int eventID)

Return the event which has the given id

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

public EventInfo newEvent (int id)

Create a new event and add it to the events list

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

Protected Methods

protected Class getListClass ()

Returns the Class items beloging to this list will be instance of.

protected String getListNodeName ()

Returns the name of the node representing children of this list.