Jadex 0.96

jadex.planlib
Class InteractionState

java.lang.Object
  extended by jadex.planlib.InteractionState

public class InteractionState
extends Object

The state of the execution of an interaction.


Field Summary
static String CANCELLATION_FAILED
          Constant identifying failed cancellation of interaction (failure explicitly stated by receiver side).
static String CANCELLATION_SUCCEEDED
          Constant identifying successful cancellation of interaction.
static String CANCELLATION_UNKNOWN
          Constant identifying unknown state of cancellation of interaction (no response from receiver side within timeout).
static String INTERACTION_CANCELLED
          Interaction state cancelled.
static String INTERACTION_FINISHED
          Interaction state finished.
static String INTERACTION_INITIAL
          Interaction state initial (not yet started).
static String INTERACTION_RUNNING
          Interaction state running.
 
Constructor Summary
InteractionState()
          Create a new interaction state in default initial state "running".
 
Method Summary
 void addCancelResponse(AgentIdentifier responder, String response, Object content)
          Add a cancel response.
 AgentIdentifier[] getCancelResponders(String response)
          Get all agents with a specific cancel response.
 String getCancelResponse(AgentIdentifier responder)
          Get the cancel response of an agent.
 Object getCancelResponseContent(AgentIdentifier responder)
          Get the details of a cancel response of a given agent.
 Object getFailure()
          Get the failure description.
 String getInteractionState()
          Get the interaction state.
 void setFailure(Object failure)
          Set the failure description.
 void setInteractionState(String interaction_state)
          Set the interaction state.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INTERACTION_INITIAL

public static final String INTERACTION_INITIAL
Interaction state initial (not yet started).

See Also:
Constant Field Values

INTERACTION_RUNNING

public static final String INTERACTION_RUNNING
Interaction state running.

See Also:
Constant Field Values

INTERACTION_CANCELLED

public static final String INTERACTION_CANCELLED
Interaction state cancelled.

See Also:
Constant Field Values

INTERACTION_FINISHED

public static final String INTERACTION_FINISHED
Interaction state finished.

See Also:
Constant Field Values

CANCELLATION_SUCCEEDED

public static final String CANCELLATION_SUCCEEDED
Constant identifying successful cancellation of interaction.

See Also:
Constant Field Values

CANCELLATION_FAILED

public static final String CANCELLATION_FAILED
Constant identifying failed cancellation of interaction (failure explicitly stated by receiver side).

See Also:
Constant Field Values

CANCELLATION_UNKNOWN

public static final String CANCELLATION_UNKNOWN
Constant identifying unknown state of cancellation of interaction (no response from receiver side within timeout).

See Also:
Constant Field Values
Constructor Detail

InteractionState

public InteractionState()
Create a new interaction state in default initial state "running".

Method Detail

getFailure

public Object getFailure()
Get the failure description.

Returns:
The failure description (if any).

setFailure

public void setFailure(Object failure)
Set the failure description.

Parameters:
failure - The failure description to set.

getInteractionState

public String getInteractionState()
Get the interaction state.

Returns:
The interaction state.

setInteractionState

public void setInteractionState(String interaction_state)
Set the interaction state.

Parameters:
interaction - state The interaction state to set.

addCancelResponse

public void addCancelResponse(AgentIdentifier responder,
                              String response,
                              Object content)
Add a cancel response.


getCancelResponders

public AgentIdentifier[] getCancelResponders(String response)
Get all agents with a specific cancel response.


getCancelResponse

public String getCancelResponse(AgentIdentifier responder)
Get the cancel response of an agent.


getCancelResponseContent

public Object getCancelResponseContent(AgentIdentifier responder)
Get the details of a cancel response of a given agent. This will be any information that the agent sent as content of the cancel response.


Jadex 0.96

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.