ABLE, Version 1.1b

com.ibm.able.platform.agents
Class FipaAclMessage

java.lang.Object
  |
  +--com.ibm.able.platform.agents.FipaAclMessage

public class FipaAclMessage
extends java.lang.Object
implements java.io.Serializable

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!

Version:
$Revision: 1.2 $, $Date: 2000/02/08 15:13:58 $
See Also:
Serialized Form

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

FipaAclMessage

public FipaAclMessage(int theMessageTypeId)
               throws java.lang.IllegalArgumentException
Create a new ACL message of the specified type.

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.

Parameters:
theMessageTypeId - An Fipa.MtId value.

Throws:
java.lang.IllegalArgumentException - is thrown if the parameter is an unrecognized message type.
Method Detail

getMessageType

public int getMessageType()
Retrieve the current message type.
Returns:
An Fipa.MtId value.

getContent

public java.lang.Object getContent()
Retrieve the "content" associated with this message.
Returns:
An Object containing the current "content" associated with this message.

setContent

public void setContent(java.lang.Object theContent)
Set (or change) the "content" associated with this message.
Parameters:
theContent - An Object containing the new "content" for this message. The specified value replaces the current value.


getConversationId

public java.lang.String getConversationId()
Retrieve the "conversation Id" associated with this message.
Returns:
A String containing the current "conversation Id" associated with this message.

setConversationId

public void setConversationId(java.lang.String theConversationId)
Set (or change) the "conversation Id" associated with this message.
Parameters:
theConversationId - A String containing the new "conversation Id" for this message. The specified value replaces the current value.


getEnvelope

public java.util.Hashtable getEnvelope()
Retrieve the "envelope" associated with this message.
Returns:
A Hashtable containing the current "envelope" associated with this message.

setEnvelope

public void setEnvelope(java.util.Hashtable theEnvelope)
Set (or change) the "envelope" associated with this message.
Parameters:
theEnvelope - A Hashtable containing the new "envelope" for this message. The specified value replaces the current value.


getInReplyTo

public java.lang.String getInReplyTo()
Retrieve the "in reply to" expression associated with this message.
Returns:
A String containing the current "in reply to" expression associated with this message.

setInReplyTo

public void setInReplyTo(java.lang.String theInReplyTo)
Set (or change) the "in reply to" expression associated with this message.
Parameters:
theInReplyTo - A String containing the new "in reply to" expression for this message. The specified value replaces the current value.


getLanguage

public java.lang.String getLanguage()
Retrieve the "language" expression associated with this message.
Returns:
A String containing the current "language" expression associated with this message.

setLanguage

public void setLanguage(java.lang.String theLanguage)
Set (or change) the "language" expression associated with this message.
Parameters:
theLanguage - A String containing the new "language" expression for this message. The specified value replaces the current value.


getOntology

public java.lang.String getOntology()
Retrieve the "ontology" expression associated with this message.
Returns:
A String containing the current "ontology" expression associated with this message.

setOntology

public void setOntology(java.lang.String theOntology)
Set (or change) the "ontology" expression associated with this message.
Parameters:
theOntology - A String containing the new "ontology" expression for this message. The specified value replaces the current value.


getProtocol

public java.lang.String getProtocol()
Retrieve the "protocol" word associated with this message.
Returns:
A String containing the current "protocol" word associated with this message.

setProtocol

public void setProtocol(java.lang.String theProtocol)
Set (or change) the "protocol" word associated with this message.
Parameters:
theProtocol - A String containing the new "protocol" word for this message. The specified value replaces the current value.


getReplyBy

public java.util.Calendar getReplyBy()
Retrieve the "reply-by" date/time token associated with this message.
Returns:
A Hashtable containing the current "reply-by" date/time token associated with this message.

setReplyBy

public void setReplyBy(java.util.Calendar theReplyBy)
Set (or change) the "reply-by" date/time token associated with this message.
Parameters:
theReplyBy - A Calendar containing the new "reply-by" date/time token for this message. The specified value replaces the current value.


getReplyWith

public java.lang.String getReplyWith()
Retrieve the "reply with" expression associated with this message.
Returns:
A String containing the current "reply with" expression associated with this message.

setReplyWith

public void setReplyWith(java.lang.String theReplyWith)
Set (or change) the "reply with" expression associated with this message.
Parameters:
theReplyWith - A String containing the new "reply with" expression for this message. The specified value replaces the current value.


getReceiver

public java.util.Vector getReceiver()
Retrieve the "receiver" associated with this message.
Returns:
A list containing the current "receiver(s)" associated with this message.

setReceiver

public void setReceiver(java.util.Vector theReceiver)
Set (or change) the "receiver(s)" associated with this message.
Parameters:
theReceiver - A list containing the new "receiver(s)" for this message. The specified value replaces the current value.


getSender

public java.lang.String getSender()
Retrieve the "sender" agent name associated with this message.
Returns:
A String containing the current "sender" agent name associated with this message.

setSender

public void setSender(java.lang.String theSender)
Set (or change) the "sender" agent name associated with this message.
Parameters:
theSender - A String containing the new "sender" agent name for this message. The specified value replaces the current value.


toString

public java.lang.String toString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.
Overrides:
toString in class java.lang.Object

debugString

public java.lang.String debugString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'