Package jade.domain.introspection

Class ReceivedMessage

java.lang.Object

jade.domain.introspection.ReceivedMessage

All Implemented Interfaces:

Concept, Term, Event, Serializable, Serializable

public class ReceivedMessage
extends Object
implements Event

An introspection event, recording the reception of an ACL message within the platform.

Version:

$Date$ $Revision$

Author:

Giovanni Rimassa - Universita' di Parma

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	A string constant for the name of this event.

Constructor Summary

Constructors

Constructor	Description
ReceivedMessage()	Default constructor.

Method Summary

Modifier and Type	Method	Description
ACLMessage	getMessage()	Retrieve the value of the message slot of this event, containing the ACL message that was extracted from the receiver agent message queue.
String	getName()	Retrieve the name of this event.
AID	getReceiver()	Retrieve the value of the receiver slot of this event, containing the agent identifier of the agent owning the message queue the message was extracted from.
AID	getSender()	Retrieve the value of the sender slot of this event, containing the agent identifier of the agent that sent the message.
void	setMessage(ACLMessage msg)	Set the message slot of this event.
void	setReceiver(AID id)	Set the receiver slot of this event.
void	setSender(AID id)	Set the sender slot of this event.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

A string constant for the name of this event.

See Also:

Constant Field Values

Constructor Detail

ReceivedMessage

public ReceivedMessage()

Default constructor. A default constructor is necessary for ontological classes.

Method Detail

getName

public String getName()

Retrieve the name of this event.

Specified by:

getName in interface Event

Returns:

A constant value for the event name.

setSender

public void setSender(AID id)

Set the sender slot of this event.

Parameters:

id - The agent identifier of the agent that sent the message.

getSender

public AID getSender()

Retrieve the value of the sender slot of this event, containing the agent identifier of the agent that sent the message.

Returns:

The value of the sender slot, or null if no value was set.

setMessage

public void setMessage(ACLMessage msg)

Set the message slot of this event.

Parameters:

msg - The ACL message that was extracted from the receiver agent message queue.

getMessage

public ACLMessage getMessage()

Retrieve the value of the message slot of this event, containing the ACL message that was extracted from the receiver agent message queue.

Returns:

The value of the message slot, or null if no value was set.

setReceiver

public void setReceiver(AID id)

Set the receiver slot of this event.

Parameters:

id - The agent identifier of the agent owning the message queue the message was extracted from.

getReceiver

public AID getReceiver()

Retrieve the value of the receiver slot of this event, containing the agent identifier of the agent owning the message queue the message was extracted from.

Returns:

The value of the receiver slot, or null if no value was set.