jade.domain.introspection
Class FrozenAgent

java.lang.Object
  jade.domain.introspection.FrozenAgent

All Implemented Interfaces:

Concept, Term, Event, java.io.Serializable

public class FrozenAgent
extends java.lang.Object
implements Event

An introspection event, recording the freezing of a formerly active agent within the platform.

Author:

Giovanni Rimassa - FRAMeTech s.r.l.

See Also:

Serialized Form

Field Summary

static java.lang.String

NAME A string constant for the name of this event.

Constructor Summary

FrozenAgent()
Default constructor.

Method Summary

AID	getAgent() Retrieve the value of the agent slot of this event, containing the agent identifier of the newly suspended agent.
ContainerID	getBufferContainer() Retrieve the value of the buffer-container slot of this event, containing the container identifier of the container where the frozen agent will appear to reside (and where ACL messages for that agent will be redirected and buffered).
java.lang.String	getName() Retrieve the name of this event.
ContainerID	getWhere() Retrieve the value of the where slot of this event, containing the container identifier of the container where the newly frozen agent was deployed.
void	setAgent(AID id) Set the agent slot of this event.
void	setBufferContainer(ContainerID id) Set the buffer-container slot of this event.
void	setWhere(ContainerID id) Set the where 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 java.lang.String NAME

A string constant for the name of this event.

See Also:

Constant Field Values

Constructor Detail

FrozenAgent

public FrozenAgent()

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

Method Detail

getName

public java.lang.String getName()

Retrieve the name of this event.

Specified by:

getName in interface Event

Returns:

A constant value for the event name.

setAgent

public void setAgent(AID id)

Set the agent slot of this event.

Parameters:

id - The agent identifier of the newly suspended agent.

getAgent

public AID getAgent()

Retrieve the value of the agent slot of this event, containing the agent identifier of the newly suspended agent.

Returns:

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

setWhere

public void setWhere(ContainerID id)

Set the where slot of this event.

Parameters:

id - The container identifier of the container where the newly frozen agent was deployed.

getWhere

public ContainerID getWhere()

Retrieve the value of the where slot of this event, containing the container identifier of the container where the newly frozen agent was deployed.

Returns:

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

setBufferContainer

public void setBufferContainer(ContainerID id)

Set the buffer-container slot of this event.

Parameters:

id - The container identifier of the container where the frozen agent will appear to reside (and where ACL messages for that agent will be redirected and buffered).

getBufferContainer

public ContainerID getBufferContainer()

Retrieve the value of the buffer-container slot of this event, containing the container identifier of the container where the frozen agent will appear to reside (and where ACL messages for that agent will be redirected and buffered).

Returns:

The value of the buffer-container slot, or null if no value was set.