ABLE, Version 1.1b

com.ibm.able.platform.agents
Class FipaLetter

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

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

This class provides an implementation of a FIPA letter.

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

Constructor Summary
FipaLetter()
          Create a new, empty FIPA letter.
FipaLetter(FipaMessageEnvelope theMessageEnvelope, java.util.Vector theMessageContent)
          Create a new FIPA letter, and initialize it with specified parameters.
 
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.util.Vector getMessageContent()
          Retrieve the current message content(s).
 FipaMessageEnvelope getMessageEnvelope()
          Retrieve the current message envelope.
 void setMessageContent(java.util.Vector theMessageContent)
          Set the current message content to the specified value.
 void setMessageEnvelope(FipaMessageEnvelope theMessageEnvelope)
          Set the current message envelope to the specified value.
 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

FipaLetter

public FipaLetter()
Create a new, empty FIPA letter. The envelope and message content must be filled in before the letter can be used or sent to an agent.

FipaLetter

public FipaLetter(FipaMessageEnvelope theMessageEnvelope,
                  java.util.Vector theMessageContent)
Create a new FIPA letter, and initialize it with specified parameters.
Parameters:
theMessageEnvelope - A valid, filled in FIPA message envelope. No validation is done on the envelope.

theMessageContent - A list of one or more AclMessage objects. This list is cloned before being inserted into the letter.

Method Detail

getMessageEnvelope

public FipaMessageEnvelope getMessageEnvelope()
Retrieve the current message envelope.
Returns:
A reference to the FIPA message envelope.

setMessageEnvelope

public void setMessageEnvelope(FipaMessageEnvelope theMessageEnvelope)
Set the current message envelope to the specified value.
Parameters:
theMessageEnvelope - A valid, filled in FIPA message envelope. No validation is done on the envelope.


getMessageContent

public java.util.Vector getMessageContent()
Retrieve the current message content(s).
Returns:
A clone of the current list of message contents.

setMessageContent

public void setMessageContent(java.util.Vector theMessageContent)
Set the current message content to the specified value.
Parameters:
theMessageContent - A list of one or more AclMessage objects. This list is cloned before being inserted into the letter.


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.'