casa.event

Class TriggerEvent

java.lang.Object

java.util.Observable

casa.event.AbstractEvent

casa.event.TriggerEvent

All Implemented Interfaces:

Event, Describable, Cloneable, Comparable<AbstractEvent>

Direct Known Subclasses:

EventObserverEvent, MessageObserverEvent

public class TriggerEvent
extends AbstractEvent

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	recurring
private boolean	started
private boolean	stop
private boolean	triggered

Fields inherited from class casa.event.AbstractEvent

agent, fired, id, priority, queueTime

Fields inherited from interface casa.event.Event

DEFAULT_PRIORITY, FIRE_EVENT, HIGHEST_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TriggerEvent(String eventType, boolean recurring, PolicyAgentInterface agent)

Method Summary

Modifier and Type	Method and Description
void	cancel() Signals that this event should actually be deleted and not repeated after the next call to delete().
void	delete() Deletes the event from the internal list of all Events.
void	fireEvent() Overrides AbstractEvent.fireEvent() by checking to see if this event has been cancel()'ed.
boolean	hasBeenQueued()
boolean	hasStarted()
boolean	hasTriggered()
boolean	isRecurring() Determines if this event is recurring.
void	start() Indicates that notification of the observers can now occur and queues the event to the agent's event queue.
void	trigger()

Methods inherited from class casa.event.AbstractEvent

clone, compareTo, getEventType, getID, getOwnerConversationID, getParameter, getPriority, getQueueTime, hasFired, keySet, setOwnerConversationID, setParameter, setParameters, setPriority, setQueueTime, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface casa.event.Event

addObserver, countObservers, deleteObserver

Field Detail

triggered

private boolean triggered

started

private boolean started

recurring

private final boolean recurring

stop

private boolean stop

Constructor Detail

TriggerEvent

public TriggerEvent(String eventType,
                    boolean recurring,
                    PolicyAgentInterface agent)

Method Detail

isRecurring

public boolean isRecurring()

Description copied from interface: Event

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

Returns:

trigger

public void trigger()

hasTriggered

public boolean hasTriggered()

hasStarted

public boolean hasStarted()

hasBeenQueued

public boolean hasBeenQueued()

start

public void start()

Description copied from interface: Event

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.

cancel

public void cancel()

Signals that this event should actually be deleted and not repeated after the next call to delete().

fireEvent

public void fireEvent()

Overrides AbstractEvent.fireEvent() by checking to see if this event has been cancel()'ed. If it has not been cancelled, AbstractEvent.fireEvent() is called.

Specified by:

fireEvent in interface Event

Overrides:

fireEvent in class AbstractEvent

delete

public void delete()

Deletes the event from the internal list of all Events. But if this is a recurring event, it doesn't delete the event unless cancel() has been previously called.

Overrides:

delete in class AbstractEvent

See Also:

AbstractEvent.delete()