org.openbp.jaspira.event
Class RequestEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.jaspira.event.RequestEvent

All Implemented Interfaces:

java.io.Serializable

public class RequestEvent
extends JaspiraEvent

A request event is used to broadcast a request to all plugins. Each plugin that wants to respond to the request can add information to a list held by the event. The originator of the event may retrieve the information from the list after the event has been processed.

Author:

Andreas Putz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openbp.jaspira.event.JaspiraEvent

CONSUMED, HANDELED, STACKABLE, TYPE_BOTTOM_UP, TYPE_DIRECT, TYPE_FLOOD, TYPE_GLOBAL, UNCONSUMABLE

Fields inherited from class java.util.EventObject

source

Constructor Summary

RequestEvent(Plugin source, java.lang.String eventName, java.lang.Object object)
Constructor.

Method Summary

void	addResult(java.lang.Object object) Adds result information.
java.util.List	getResultList() Gets the list of result information objects.

Methods inherited from class org.openbp.jaspira.event.JaspiraEvent

brand, getBrand, getEventGroup, getEventName, getFlags, getLevel, getObject, getOriginalEvent, getSourcePlugin, getTargetClassName, getTargetPluginId, getType, isConsumed, isStackable, isUnconsumable, setObject, setTargetClassName, setTargetPluginId, toString, updateFlags, updateFlags

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestEvent

public RequestEvent(Plugin source,
                    java.lang.String eventName,
                    java.lang.Object object)

Constructor.

Parameters:

source - Source plugin

eventName - Name of the event

object - Event object

Method Detail

addResult

public void addResult(java.lang.Object object)

Adds result information.

Parameters:

object - Result object to add

getResultList

public java.util.List getResultList()

Gets the list of result information objects.

Returns:

The list of result objects or null if no plugin responded to the event