Package jade.domain.introspection

Class ACLMessage

java.lang.Object

jade.domain.introspection.ACLMessage

All Implemented Interfaces:

Concept, Term, Serializable, Serializable

public class ACLMessage
extends Object
implements Concept

This class represents an ACL message.

Version:

$Date$ $Revision$

Author:

Giovanni Rimassa - Universita` di Parma

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ACLMessage()	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getAclRepresentation()	Retrieve the representation of the message payload.
Envelope	getEnvelope()	Retrieve the message envelope.
String	getPayload()	Retrieve the payload (i.e.
void	setAclRepresentation(String r)	Set the representation of the message payload.
void	setEnvelope(Envelope e)	Set the message envelope.
void	setPayload(String p)	Set the payload (i.e.

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(String r)

Set the representation of the message payload.

Parameters:

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

getAclRepresentation

public String getAclRepresentation()

Retrieve the representation of the message payload.

Returns:

The ACL representation of the message.

setPayload

public void setPayload(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 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.