jadex.runtime
Interface IExternalAccess

All Superinterfaces:

ICapability, IElement

public interface IExternalAccess

extends ICapability

The interface for external threads.

Method Summary

IGoal	createGoal(String type) Create a goal from a template goal.
IInternalEvent	createInternalEvent(String type) Create a new intenal event.
IInternalEvent	createInternalEvent(String type, Object content) Deprecated. Convenience method for easy conversion to new explicit internal events. Will be removed in later releases.
IMessageEvent	createMessageEvent(String type) Create a new message event.
IMessageEvent	createMessageEventFromNative(Object message, String metype) Deprecated. Use createMessageEvent(String type) instead.
void	dispatchInternalEvent(IInternalEvent event) Dispatch an internal event.
void	dispatchTopLevelGoal(IGoal goal) Dispatch a new top-level goal.
IGoalEvent	dispatchTopLevelGoalAndWait(IGoal goal) Dispatch a top level goal and wait for the result.
IGoalEvent	dispatchTopLevelGoalAndWait(IGoal goal, long timeout) Dispatch a top level goal and wait for the result.
IFilter	sendMessage(IMessageEvent me) Send a message after some delay.
IMessageEvent	sendMessageAndWait(IMessageEvent me) Send a message and wait for the answer.
IMessageEvent	sendMessageAndWait(IMessageEvent me, long timeout) Send a message and wait for the answer.
IEvent	waitFor(long duration) Wait for a some time.
IInternalEvent	waitForBeliefChange(String type) Wait for a belief change.
IInternalEvent	waitForBeliefChange(String type, long timeout) Wait for a belief change.
IEvent	waitForCondition(ICondition condition) Wait for a condition to be satisfied.
IEvent	waitForCondition(ICondition condition, long timeout) Wait for a condition or until the timeout occurs.
IEvent	waitForCondition(String condition) Wait for a condition to be satisfied.
IEvent	waitForCondition(String condition, long timeout) Wait for a condition to be satisfied.
Object	waitForFactAdded(String type) Wait for a belief set change.
Object	waitForFactAdded(String type, long timeout) Wait for a belief set change.
Object	waitForFactAddedOrRemoved(String type) Wait for a belief set change.
Object	waitForFactAddedOrRemoved(String type, long timeout) Wait for a belief set change.
Object	waitForFactRemoved(String type) Wait for a belief set change.
Object	waitForFactRemoved(String type, long timeout) Wait for a belief set change.
IGoalEvent	waitForGoal(String type) Wait for a goal.
IGoalEvent	waitForGoal(String type, long timeout) Wait for a goal.
IInternalEvent	waitForInternalEvent(String type) Wait for an internal event.
IInternalEvent	waitForInternalEvent(String type, long timeout) Wait for an internal event.
IMessageEvent	waitForMessageEvent(String type) Wait for a message event.
IMessageEvent	waitForMessageEvent(String type, long timeout) Wait for a message event.
IMessageEvent	waitForReply(IMessageEvent msgevent) Wait for a message.
IMessageEvent	waitForReply(IMessageEvent msgevent, long timeout) Wait for a message.

Methods inherited from interface jadex.runtime.ICapability

addSubcapability, deregisterSubcapability, getAgentIdentifier, getAgentName, getBeliefbase, getEventbase, getExpressionbase, getExternalAccess, getGoalbase, getInitialStateName, getLogger, getPlanbase, getPlatformAgent, getPlatformType, getPropertybase, killAgent, registerSubcapability, removeSubcapability

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Method Detail

dispatchTopLevelGoal

public void dispatchTopLevelGoal(IGoal goal)

Dispatch a new top-level goal.

Parameters:

goal - The new goal. Note: plan step is interrupted after call.

createGoal

public IGoal createGoal(String type)

Create a goal from a template goal. To be processed, the goal has to be dispatched as subgoal or adopted as top-level goal.

Parameters:

type - The template goal name as specified in the ADF.

Returns:

The created goal.

sendMessage

public IFilter sendMessage(IMessageEvent me)

Send a message after some delay.

Parameters:

me - The message event.

Returns:

The filter to wait for an answer.

dispatchInternalEvent

public void dispatchInternalEvent(IInternalEvent event)

Dispatch an internal event.

Parameters:

event - The event. Note: plan step is interrupted after call.

createMessageEventFromNative

public IMessageEvent createMessageEventFromNative(Object message,
                                                  String metype)

Deprecated. Use createMessageEvent(String type) instead.

Create a new message event.

Returns:

The new message event.

createMessageEvent

public IMessageEvent createMessageEvent(String type)

Create a new message event.

Returns:

The new message event.

createInternalEvent

public IInternalEvent createInternalEvent(String type)

Create a new intenal event.

Returns:

The new intenal event.

createInternalEvent

public IInternalEvent createInternalEvent(String type,
                                          Object content)

Deprecated. Convenience method for easy conversion to new explicit internal events. Will be removed in later releases.

Create a new intenal event.

Returns:

The new intenal event.

waitFor

public IEvent waitFor(long duration)

Wait for a some time.

Parameters:

duration - The duration.

waitForCondition

public IEvent waitForCondition(ICondition condition)

Wait for a condition to be satisfied.

Parameters:

condition - The condition.

waitForCondition

public IEvent waitForCondition(ICondition condition,
                               long timeout)

Wait for a condition or until the timeout occurs.

Parameters:

condition - The condition.

timeout - The timeout.

waitForCondition

public IEvent waitForCondition(String condition)

Wait for a condition to be satisfied.

Parameters:

condition - The condition.

waitForCondition

public IEvent waitForCondition(String condition,
                               long timeout)

Wait for a condition to be satisfied.

Parameters:

condition - The condition.

waitForInternalEvent

public IInternalEvent waitForInternalEvent(String type)

Wait for an internal event.

Parameters:

type - The internal event type.

waitForInternalEvent

public IInternalEvent waitForInternalEvent(String type,
                                           long timeout)

Wait for an internal event.

Parameters:

type - The internal event type.

timeout - The timeout.

sendMessageAndWait

public IMessageEvent sendMessageAndWait(IMessageEvent me)

Send a message and wait for the answer.

Parameters:

me - The message event.

Returns:

The result event.

sendMessageAndWait

public IMessageEvent sendMessageAndWait(IMessageEvent me,
                                        long timeout)

Send a message and wait for the answer. Adds a reply-with entry if not present, for tracking the conversation.

Parameters:

me - The message event.

timeout - The timeout.

Returns:

The result event.

waitForMessageEvent

public IMessageEvent waitForMessageEvent(String type)

Wait for a message event.

Parameters:

type - The message event type.

waitForMessageEvent

public IMessageEvent waitForMessageEvent(String type,
                                         long timeout)

Wait for a message event.

Parameters:

type - The message event type.

timeout - The timeout.

waitForReply

public IMessageEvent waitForReply(IMessageEvent msgevent)

Wait for a message.

Parameters:

msgevent - The message event.

waitForReply

public IMessageEvent waitForReply(IMessageEvent msgevent,
                                  long timeout)

Wait for a message.

Parameters:

msgevent - The message event.

waitForGoal

public IGoalEvent waitForGoal(String type)

Wait for a goal.

Parameters:

type - The goal type.

waitForGoal

public IGoalEvent waitForGoal(String type,
                              long timeout)

Wait for a goal.

Parameters:

type - The goal type.

timeout - The timeout.

waitForBeliefChange

public IInternalEvent waitForBeliefChange(String type)

Wait for a belief change.

Parameters:

type - The internal event type. todo: returns a condition triggered event? or new BeliefChanged event?

waitForBeliefChange

public IInternalEvent waitForBeliefChange(String type,
                                          long timeout)

Wait for a belief change.

Parameters:

type - The belief type.

timeout - The todo: returns a condition triggered event? or new BeliefChanged event?

waitForFactAddedOrRemoved

public Object waitForFactAddedOrRemoved(String type)

Wait for a belief set change.

Parameters:

type - The belief set type. todo: returns a condition triggered event? or new BeliefChanged event?

waitForFactAddedOrRemoved

public Object waitForFactAddedOrRemoved(String type,
                                        long timeout)

Wait for a belief set change.

Parameters:

type - The belief set type.

timeout - The timeout. todo: returns a condition triggered event? or new BeliefChanged event?

waitForFactAdded

public Object waitForFactAdded(String type)

Wait for a belief set change.

Parameters:

type - The belief set type.

Returns:

The fact that was added.

waitForFactAdded

public Object waitForFactAdded(String type,
                               long timeout)

Wait for a belief set change.

Parameters:

type - The belief set type.

timeout - The timeout.

Returns:

The fact that was added.

waitForFactRemoved

public Object waitForFactRemoved(String type)

Wait for a belief set change.

Parameters:

type - The belief set type.

Returns:

The fact that was added.

waitForFactRemoved

public Object waitForFactRemoved(String type,
                                 long timeout)

Wait for a belief set change.

Parameters:

type - The belief set type.

timeout - The timeout.

Returns:

The fact that was added.

dispatchTopLevelGoalAndWait

public IGoalEvent dispatchTopLevelGoalAndWait(IGoal goal)

Dispatch a top level goal and wait for the result.

Parameters:

goal - The goal.

dispatchTopLevelGoalAndWait

public IGoalEvent dispatchTopLevelGoalAndWait(IGoal goal,
                                              long timeout)

Dispatch a top level goal and wait for the result.

Parameters:

goal - The goal.