|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the notion of a Conversation which is comprised of several Message's, the order of which follow a certain protocol (e.g. FIPA-Request). The methods it provides allow retrieval of information about the conversation.
Field Summary | |
static int |
AGENT_ACTION_REQ
Conversation requires Agent interaction - This is generally the state whenever the latest message in the conversation is from an Agent other than the owner of the Conversation object, and the conversation update hasn't been propogated to a ConversationListener |
static int |
CONVERSATION_END
Conversation has ended - This state is entered once the last message in the conversation has been received, or the last message recieved has timed-out. |
static int |
NO_AGENT_ACTION_REQ
Conversation requires no Agent interaction - This is generally the state whenever the last message that was part of a conversation was sent by the Agent that owns this Conversation object, or a conversation update has already been forwarded to the ConversationListener for the latest update |
static int |
WAIT_BEFORE_END
Wait for response before ending conversation - Indicates that a reply-by time was specified on the last message in the conversation, so this is a special case of NO_AGENT_ACTION_REQ. |
Method Summary | |
ACL |
getACL(int index)
Pass-back the latest message in this conversation |
java.lang.String |
getConversationID()
Gets the conversation ID of the conversation |
Envelope |
getEnvelope(int index)
Get the Envelope of the latest message received |
ACL |
getFilledInACL()
Method to produce a filled in ACL - e.g. |
int |
getLatestMessageIndex()
Pass back the index of the latest message in the conversation |
java.util.List |
getNextMessages()
Method to discover what types of messages can be sent next |
java.util.List |
getNextPerformatives()
Method to discover what performatives are allowed next in the protocol. |
java.lang.String |
getProtocol()
Method to get the protocol this Conversation is following |
java.lang.String |
getSender(int index)
Gets the sender of the message at the specified index |
AgentID |
getSenderAID(int index)
Gets the sender of the message at the specified index |
int |
getState()
Method to retrieve the state of the conversation (e.g. |
long |
getTimeOut()
Method to get the time at which the last message will time out |
long |
getTimeStamp(int index)
Method to retrieve the time stamp of a given message |
Methods inherited from interface fipaos.skill.db.DatabaseObject |
getObjectID |
Field Detail |
public static final int CONVERSATION_END
public static final int NO_AGENT_ACTION_REQ
public static final int AGENT_ACTION_REQ
public static final int WAIT_BEFORE_END
Method Detail |
public int getLatestMessageIndex()
public ACL getACL(int index)
public Envelope getEnvelope(int index)
public java.lang.String getSender(int index)
index
- The index of the message to retrievepublic AgentID getSenderAID(int index)
index
- The index of the message to retrievepublic long getTimeStamp(int index)
index
- The index of the message for which to retrieve the timestamppublic long getTimeOut()
public java.util.List getNextPerformatives()
public java.util.List getNextMessages()
public ACL getFilledInACL()
public java.lang.String getProtocol()
public java.lang.String getConversationID()
public int getState()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |