|
ABLE, Version 1.1b | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.platform.agents.FipaAclMessage
This class provides an implementation of a FIPA ACL message.
Note that there are no "smarts" built in to this class. It is up to the user to make sure that the message, when filled out, contains the proper required bits for the specified message type, and that the message otherwise makes sense to its intended recipients!
Constructor Summary | |
FipaAclMessage(int theMessageTypeId)
Create a new ACL message of the specified type. |
Method Summary | |
static java.lang.String |
Copyright()
Determine the copyright of this class. |
java.lang.String |
debugString()
Retrieve a string describing (the contents of) the object. |
java.lang.Object |
getContent()
Retrieve the "content" associated with this message. |
java.lang.String |
getConversationId()
Retrieve the "conversation Id" associated with this message. |
java.util.Hashtable |
getEnvelope()
Retrieve the "envelope" associated with this message. |
java.lang.String |
getInReplyTo()
Retrieve the "in reply to" expression associated with this message. |
java.lang.String |
getLanguage()
Retrieve the "language" expression associated with this message. |
int |
getMessageType()
Retrieve the current message type. |
java.lang.String |
getOntology()
Retrieve the "ontology" expression associated with this message. |
java.lang.String |
getProtocol()
Retrieve the "protocol" word associated with this message. |
java.util.Vector |
getReceiver()
Retrieve the "receiver" associated with this message. |
java.util.Calendar |
getReplyBy()
Retrieve the "reply-by" date/time token associated with this message. |
java.lang.String |
getReplyWith()
Retrieve the "reply with" expression associated with this message. |
java.lang.String |
getSender()
Retrieve the "sender" agent name associated with this message. |
void |
setContent(java.lang.Object theContent)
Set (or change) the "content" associated with this message. |
void |
setConversationId(java.lang.String theConversationId)
Set (or change) the "conversation Id" associated with this message. |
void |
setEnvelope(java.util.Hashtable theEnvelope)
Set (or change) the "envelope" associated with this message. |
void |
setInReplyTo(java.lang.String theInReplyTo)
Set (or change) the "in reply to" expression associated with this message. |
void |
setLanguage(java.lang.String theLanguage)
Set (or change) the "language" expression associated with this message. |
void |
setOntology(java.lang.String theOntology)
Set (or change) the "ontology" expression associated with this message. |
void |
setProtocol(java.lang.String theProtocol)
Set (or change) the "protocol" word associated with this message. |
void |
setReceiver(java.util.Vector theReceiver)
Set (or change) the "receiver(s)" associated with this message. |
void |
setReplyBy(java.util.Calendar theReplyBy)
Set (or change) the "reply-by" date/time token associated with this message. |
void |
setReplyWith(java.lang.String theReplyWith)
Set (or change) the "reply with" expression associated with this message. |
void |
setSender(java.lang.String theSender)
Set (or change) the "sender" agent name associated with this message. |
java.lang.String |
toString()
Retrieve a string describing (the contents of) the object. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public FipaAclMessage(int theMessageTypeId) throws java.lang.IllegalArgumentException
In order to be useful, message parameters must be filled in by calling the available and appropriate 'set' methods. But note that the ACL message type must be specified on the constructor and cannot be changed once the object has been created.
theMessageTypeId
- An Fipa.MtMethod Detail |
public int getMessageType()
public java.lang.Object getContent()
public void setContent(java.lang.Object theContent)
theContent
- An Object containing the new "content" for this message.
The specified value replaces the current value.
public java.lang.String getConversationId()
public void setConversationId(java.lang.String theConversationId)
theConversationId
- A String containing the new "conversation Id" for this message.
The specified value replaces the current value.
public java.util.Hashtable getEnvelope()
public void setEnvelope(java.util.Hashtable theEnvelope)
theEnvelope
- A Hashtable containing the new "envelope" for this message.
The specified value replaces the current value.
public java.lang.String getInReplyTo()
public void setInReplyTo(java.lang.String theInReplyTo)
theInReplyTo
- A String containing the new "in reply to" expression for this message.
The specified value replaces the current value.
public java.lang.String getLanguage()
public void setLanguage(java.lang.String theLanguage)
theLanguage
- A String containing the new "language" expression for this message.
The specified value replaces the current value.
public java.lang.String getOntology()
public void setOntology(java.lang.String theOntology)
theOntology
- A String containing the new "ontology" expression for this message.
The specified value replaces the current value.
public java.lang.String getProtocol()
public void setProtocol(java.lang.String theProtocol)
theProtocol
- A String containing the new "protocol" word for this message.
The specified value replaces the current value.
public java.util.Calendar getReplyBy()
public void setReplyBy(java.util.Calendar theReplyBy)
theReplyBy
- A Calendar containing the new "reply-by" date/time
token for this message.
The specified value replaces the current value.
public java.lang.String getReplyWith()
public void setReplyWith(java.lang.String theReplyWith)
theReplyWith
- A String containing the new "reply with" expression for this message.
The specified value replaces the current value.
public java.util.Vector getReceiver()
public void setReceiver(java.util.Vector theReceiver)
theReceiver
- A list containing the new "receiver(s)" for this message.
The specified value replaces the current value.
public java.lang.String getSender()
public void setSender(java.lang.String theSender)
theSender
- A String containing the new "sender" agent name for this message.
The specified value replaces the current value.
public java.lang.String toString()
public java.lang.String debugString()
public static java.lang.String Copyright()
|
ABLE, Version 1.1b | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |