ABLE, Version 1.1b

com.ibm.able.platform.agents
Class FipaMessageEnvelope

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

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

This class provides an implementation of a FIPA "message-envelope", part of a "fipa-letter".

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

Constructor Summary
FipaMessageEnvelope()
          Create a new, empty FIPA message envelope.
FipaMessageEnvelope(java.lang.String theDestination, java.lang.String theSenderDetails)
          Create a new FIPA message envelope, and initialize it with specified parameters.
FipaMessageEnvelope(java.lang.String theDestination, java.lang.String theSenderDetails, java.lang.String theDelegateAgent, java.lang.String theReply)
          Create a new FIPA message envelope, 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.lang.String getDelegateAgent()
          Retrieve the name of the delegate agent.
 java.lang.String getDestination()
          Retrieve the name of the agent that is to receive the letter.
 java.lang.String getReply()
          Retrieve the name of the reply agent.
 java.lang.String getSenderDetails()
          Retrieve the name of the sending agent.
 void setDelegateAgent(java.lang.String theDelegateAgent)
          Set the name of the delegate agent.
 void setDestination(java.lang.String theDestination)
          Set the name of the agent that is to receive the letter.
 void setReply(java.lang.String theReply)
          Set the name of the reply agent.
 void setSenderDetails(java.lang.String theSenderDetails)
          Set the name of the sending agent.
 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

FipaMessageEnvelope

public FipaMessageEnvelope()
Create a new, empty FIPA message envelope. The content must be filled in before the envelope can be used.

FipaMessageEnvelope

public FipaMessageEnvelope(java.lang.String theDestination,
                           java.lang.String theSenderDetails)
Create a new FIPA message envelope, and initialize it with specified parameters.
Parameters:
theDestination - The name of the agent that is to receive the letter.

theSenderDetails - The name of the agent sending the letter.


FipaMessageEnvelope

public FipaMessageEnvelope(java.lang.String theDestination,
                           java.lang.String theSenderDetails,
                           java.lang.String theDelegateAgent,
                           java.lang.String theReply)
Create a new FIPA message envelope, and initialize it with specified parameters.
Parameters:
theDestination - The name of the agent that is to receive the letter.

theSenderDetails - The name of the agent sending the letter.

theDelegateAgent - The name of the agent that will handle delegation.

theReply - The name of the agent that will handle the reply.

Method Detail

getDestination

public java.lang.String getDestination()
Retrieve the name of the agent that is to receive the letter.
Returns:
An agent name.

setDestination

public void setDestination(java.lang.String theDestination)
Set the name of the agent that is to receive the letter.
Parameters:
theDestination - A name of a registered agent.


getSenderDetails

public java.lang.String getSenderDetails()
Retrieve the name of the sending agent.
Returns:
An agent name.

setSenderDetails

public void setSenderDetails(java.lang.String theSenderDetails)
Set the name of the sending agent.
Parameters:
theSenderDetails - A name of a registered agent.


getDelegateAgent

public java.lang.String getDelegateAgent()
Retrieve the name of the delegate agent.
Returns:
An agent name.

setDelegateAgent

public void setDelegateAgent(java.lang.String theDelegateAgent)
Set the name of the delegate agent.
Parameters:
theDelegateAgent - A name of a registered agent.


getReply

public java.lang.String getReply()
Retrieve the name of the reply agent.
Returns:
An agent name.

setReply

public void setReply(java.lang.String theReply)
Set the name of the reply agent.
Parameters:
theReply - A name of a registered agent.


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