Jadex 0.96-beta1

jadex.runtime
Interface IWaitqueue


public interface IWaitqueue

Interface for the waitqueue of plans. The waitqueue makes a plan plan responsive to events permanently.


Method Summary
 void addCondition(ICondition condition)
          Add a condition.
 void addFilter(IFilter filter)
          Add a user filter.
 void addGoal(String type)
          Add a goal.
 void addInternalEvent(String type)
          Add an internal event.
 void addMessageEvent(String type)
          Add a message event.
 void addReply(IMessageEvent me)
          Add a message event reply.
 void addSubgoal(IGoal subgoal)
          Add a subgoal.
 IEvent[] getEvents()
          Get all waitqueue events.
 IEvent[] getEvents(IFilter filter)
          Get all waitqueue events that match the filter.
 boolean isEmpty()
          Test if the waitqueue is empty.
 void removeCondition(ICondition condition)
          Remove a condition.
 void removeFilter(IFilter filter)
          Remove a user filter.
 void removeGoal(IGoal subgoal)
          Remove a subgoal.
 void removeGoal(String type)
          Remove a goal.
 void removeInternalEvent(String type)
          Remove an internal event.
 void removeMessageEvent(String type)
          Remove a message event.
 void removeReply(IMessageEvent me)
          Remove a message event reply.
 int size()
          Get the number of events in the waitqueue.
 

Method Detail

getEvents

IEvent[] getEvents()
Get all waitqueue events.

Returns:
The suitable events.

getEvents

IEvent[] getEvents(IFilter filter)
Get all waitqueue events that match the filter. Removes the matching events from the waitqueue.

Parameters:
filter - The filter.
Returns:
The suitable events.

addMessageEvent

void addMessageEvent(String type)
Add a message event.

Parameters:
type - The type.

addReply

void addReply(IMessageEvent me)
Add a message event reply.

Parameters:
me - The message event.

addInternalEvent

void addInternalEvent(String type)
Add an internal event.

Parameters:
type - The type.

addGoal

void addGoal(String type)
Add a goal.

Parameters:
type - The type.

addSubgoal

void addSubgoal(IGoal subgoal)
Add a subgoal.

Parameters:
subgoal - The subgoal.

addFilter

void addFilter(IFilter filter)
Add a user filter.

Parameters:
filter - The user filter.

addCondition

void addCondition(ICondition condition)
Add a condition.

Parameters:
condition - The condition.

removeMessageEvent

void removeMessageEvent(String type)
Remove a message event.

Parameters:
type - The type.

removeReply

void removeReply(IMessageEvent me)
Remove a message event reply.

Parameters:
me - The message event.

removeInternalEvent

void removeInternalEvent(String type)
Remove an internal event.

Parameters:
type - The type.

removeGoal

void removeGoal(String type)
Remove a goal.

Parameters:
type - The type.

removeGoal

void removeGoal(IGoal subgoal)
Remove a subgoal.

Parameters:
subgoal - The subgoal.

removeFilter

void removeFilter(IFilter filter)
Remove a user filter.

Parameters:
filter - The user filter.

removeCondition

void removeCondition(ICondition condition)
Remove a condition.

Parameters:
condition - The condition.

size

int size()
Get the number of events in the waitqueue.


isEmpty

boolean isEmpty()
Test if the waitqueue is empty.


Jadex 0.96-beta1

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.