jade.domain.introspection
Class ACLMessage

java.lang.Object
  jade.domain.introspection.ACLMessage

All Implemented Interfaces:

Concept, Term, java.io.Serializable

public class ACLMessage
extends java.lang.Object
implements Concept

This class represents an ACL message.

Version:

$Date: 2005-02-16 18:18:28 +0100 (mer, 16 feb 2005) $ $Revision: 5552 $

Author:

Giovanni Rimassa - Universita` di Parma

See Also:

Serialized Form

Constructor Summary

ACLMessage()
Default constructor.

Method Summary

java.lang.String	getAclRepresentation() Retrieve the representation of the message payload.
Envelope	getEnvelope() Retrieve the message envelope.
java.lang.String	getPayload() Retrieve the payload (i.e. the speech act level part) of this ACL message.
void	setAclRepresentation(java.lang.String r) Set the representation of the message payload.
void	setEnvelope(Envelope e) Set the message envelope.
void	setPayload(java.lang.String p) Set the payload (i.e. the speech act level part) of this ACL message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ACLMessage

public ACLMessage()

Default constructor. A default constructor is necessaty for JADE ontological classes.

Method Detail

setEnvelope

public void setEnvelope(Envelope e)

Set the message envelope.

Parameters:

e - The transport-level envelope to attach to this ACL message.

getEnvelope

public Envelope getEnvelope()

Retrieve the message envelope.

Returns:

The transport-level envelope attached to this ACL message, or null if no envelope was set.

setAclRepresentation

public void setAclRepresentation(java.lang.String r)

Set the representation of the message payload.

Parameters:

r - The name of the representation expressing the message payload.

getAclRepresentation

public java.lang.String getAclRepresentation()

Retrieve the representation of the message payload.

Returns:

The ACL representation of the message.

setPayload

public void setPayload(java.lang.String p)

Set the payload (i.e. the speech act level part) of this ACL message.

Parameters:

p - A string containing the encoding of the payload according to a concrete ACL representaiton.

getPayload

public java.lang.String getPayload()

Retrieve the payload (i.e. the speech act level part) of this ACL message.

Returns:

A string containing the encoding of the payload according to a concrete ACL representation.