Package com.microstrategy.web.beans

Class EventHandlerInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.beans.EventHandlerInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class EventHandlerInfo
extends AbstractConfigurationElement

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.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_NAME
static java.lang.String	ATT_TYPE
static java.lang.String	NODE_EVENT_HANDLER

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
EventHandlerInfo()	Default constructor.
EventHandlerInfo(int type)	Constructor: Set the type field for the event handler
EventHandlerInfo(int type, java.lang.String name)	Constructor: Set the "type" and "name" field for this event handler

Method Summary

Modifier and Type	Method	Description
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
protected java.lang.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.
java.lang.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(java.lang.String name)	Set the name field value
void	setType(int type)	Set the type field value

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_EVENT_HANDLER

public static final java.lang.String NODE_EVENT_HANDLER

See Also:

Constant Field Values

ATT_TYPE

public static final java.lang.String ATT_TYPE

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

Constructor Detail

EventHandlerInfo

public EventHandlerInfo()

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

EventHandlerInfo

public EventHandlerInfo(int type)

Constructor: Set the type field for the event handler

Parameters:

type - The event handler "type" for this object

EventHandlerInfo

public EventHandlerInfo(int type,
                        java.lang.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

Method Detail

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

getType

public int getType()

Return the type field value

Returns:

The "type" associated with this event handler

setType

public void setType(int type)

Set the type field value

Parameters:

type - The new value for the "type" attribute

getName

public java.lang.String getName()

Return the name field value

Returns:

The "name" associated with this event handler

setName

public void setName(java.lang.String name)

Set the name field value

Parameters:

name - The new value for the "name" attribute

getEvent

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

deleteEvent

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

newEvent

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

getEventsList

public EventInfoList getEventsList()

Return the list of events associated with this event handler

Returns:

The events list for this handler