casa.event

Interface Event

All Superinterfaces:

Cloneable, Describable

All Known Implementing Classes:

AbstractEvent, DutchAuctionAgent.RecurringCryEvent, EventObserverEvent, MessageEvent, MessageObserverEvent, NonRecurringEvent, RecurringEvent, RecurringTimeEvent, TimeEvent, TriggerEvent

public interface Event
extends Describable

The Event interface describes an interrupt style event. Each event must have access to a thread to monitor or wait for the event to occur. When it does, it informs all observers of the event.

All events have an type, which may be used by the event observers to distinguish between multiple events it is observing.

If an observer wishes to be informed of the occurrence of the event, it must implement the EventObserver interface. The observer object must also be passed on to #addEventObserver(EventObserver) . If the observer is added before start() is called, it is guaranteed to be informed of the event's occurrence. If not, there is no guarantee. When the event occurs, EventObserver.notifyEventOccurred(String,Event,Object) is called for all registered observers.

Version:

0.9

Author:

Jason Heard

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY The default priority given to any message without priority field, or with a mangles priority field.
static CasaLispOperator	FIRE_EVENT Lisp operator: (FIRE-EVENT) Fire the current event.
static int	HIGHEST_PRIORITY

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer o) This method adds an Observer to the observer list.
int	countObservers()
void	deleteObserver(Observer o)
void	fireEvent() This method calls EventObserver.notifyEventOccurred(String, Event, Object) for all observers that have been registered via #addEventObserver(EventObserver).
String	getEventType() This method returns the type of this event.
int	getID()
String	getOwnerConversationID() conversationID getter
String	getParameter(String key) Retrieves a parameter of this object.
int	getPriority() Indicates the priority of the event
long	getQueueTime() Used by the EventQueue to set the time this event was queued
boolean	isRecurring() Determines if this event is recurring.
void	setOwnerConversationID(String id) conversationID setter
void	setParameter(String key, String value) Add the key/value pair to the parameters associated with this event.
void	setParameters(Map<String,String> list) Add the key/value pairs in list to the parameters associated with this event.
int	setPriority(int priority) Sets the priority of the event
void	setQueueTime(long time) Used by the EventQueue to sort events
void	start() Indicates that notification of the observers can now occur and queues the event to the agent's event queue.

Methods inherited from interface casa.interfaces.Describable

clone, keySet

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

The default priority given to any message without priority field, or with a mangles priority field.

See Also:

Constant Field Values

HIGHEST_PRIORITY

static final int HIGHEST_PRIORITY

See Also:

Constant Field Values

FIRE_EVENT

static final CasaLispOperator FIRE_EVENT

Lisp operator: (FIRE-EVENT)
Fire the current event.

Method Detail

addObserver

void addObserver(Observer o)

This method adds an Observer to the observer list. All observers should be notified via Observer.update(Observable, Object) when this event occurs.

Parameters:

observer - The EventObserver to add to the observer list.

deleteObserver

void deleteObserver(Observer o)

countObservers

int countObservers()

Returns:

The number of observers observing this event

getEventType

String getEventType()

This method returns the type of this event.

Returns:

The type of this event.

isRecurring

boolean isRecurring()

Determines if this event is recurring. A recurring event can occur multiple times. Returns true if the event is recurring; false otherwise.

Returns:

true if the event is recurring; false otherwise.

start

void start()

Indicates that notification of the observers can now occur and queues the event to the agent's event queue. Before this is called, this event should never call any of its observers EventObserver.notifyEventOccurred(String, Event, Object) method.

fireEvent

void fireEvent()

This method calls EventObserver.notifyEventOccurred(String, Event, Object) for all observers that have been registered via #addEventObserver(EventObserver).

getPriority

int getPriority()

Indicates the priority of the event

Returns:

the priority of this event

setPriority

int setPriority(int priority)

Sets the priority of the event

Returns:

the parameter, which is the new priority

getQueueTime

long getQueueTime()

Used by the EventQueue to set the time this event was queued

Returns:

setQueueTime

void setQueueTime(long time)

Used by the EventQueue to sort events

Parameters:

time -

getOwnerConversationID

String getOwnerConversationID()

conversationID getter

setOwnerConversationID

void setOwnerConversationID(String id)
                     throws IllegalOperationException

conversationID setter

Parameters:

id -

Throws:

IllegalOperationException

getID

int getID()

setParameters

void setParameters(Map<String,String> list)

Add the key/value pairs in list to the parameters associated with this event.

Parameters:

list - key/value pairs

setParameter

void setParameter(String key,
                  String value)

Add the key/value pair to the parameters associated with this event.

Specified by:

setParameter in interface Describable

Parameters:

key - the key name.

value - the value associated with the key.

getParameter

String getParameter(String key)

Description copied from interface: Describable

Retrieves a parameter of this object. If the parameter is not found, returns null.

Specified by:

getParameter in interface Describable

Parameters:

key - the key name

Returns:

The value associated with key or null if there is not such key.