| |||||||||
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 | |
final 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 |
final 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. |
final 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 |
final 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 |
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 |
List | getNextMessages() Method to discover what types of messages can be sent next |
List | getNextPerformatives() Method to discover what performatives are allowed next in the protocol. |
String | getProtocol() Method to get the protocol this Conversation is following |
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 final static int AGENT_ACTION_REQ
public final static int CONVERSATION_END
public final static int NO_AGENT_ACTION_REQ
public final static int WAIT_BEFORE_END
Method Detail |
public ACL getACL(int index)
public String getConversationID()
public Envelope getEnvelope(int index)
public ACL getFilledInACL()
public int getLatestMessageIndex()
public List getNextMessages()
public List getNextPerformatives()
public String getProtocol()
public String getSender(int index)
public AgentID getSenderAID(int index)
public int getState()
public long getTimeOut()
public long getTimeStamp(int index)
| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |