/*****************************************************************
JADE - Java Agent DEvelopment Framework is a framework to develop
multi-agent systems in compliance with the FIPA specifications.
Copyright (C) 2000 CSELT S.p.A. 

GNU Lesser General Public License

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation, 
version 2.1 of the License. 

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA  02111-1307, USA.
*****************************************************************/


package jade.domain.introspection;

import jade.core.AID;
import jade.core.ContainerID;

/**
   An introspection event, recording the migration of an agent within
   the platform.

   @author Giovanni Rimassa -  Universita' di Parma
   @version $Date: 2003-11-19 17:04:37 +0100 (mer, 19 nov 2003) $ $Revision: 4567 $
*/

public class MovedAgent implements Event {

    /**
       A string constant for the name of this event.
    */
    public static final String NAME = "Moved-Agent";

    private AID agent;
    private ContainerID from;
    private ContainerID to;


    /**
       Default constructor. A default constructor is necessary for
       ontological classes.
    */
    public MovedAgent() {
    }

    /**
       Retrieve the name of this event.
       @return A constant value for the event name.
    */
    public String getName() {
	return NAME;
    }

    /**
       Set the <code>agent</code> slot of this event.
       @param id The agent identifier of the newly moved agent.
    */
    public void setAgent(AID id) {
	agent = id;
    }

    /**
       Retrieve the value of the <code>agent</code> slot of this
       event, containing the agent identifier of the newly moved agent.
       @return The value of the <code>agent</code> slot, or
       <code>null</code> if no value was set.
    */
    public AID getAgent() {
	return agent;
    }


    /**
       Set the <code>from</code> slot of this event.
       @param id The container identifier of the container from where
       the agent migrated.
    */
    public void setFrom(ContainerID id) {
	from = id;
    }

    /**
       Retrieve the value of the <code>from</code> slot of this event,
       containing the container identifier of the container from where
       the agent migrated.
       @return The value of the <code>from</code> slot, or
       <code>null</code> if no value was set.
    */
    public ContainerID getFrom() {
	return from;
    }

    /**
       Set the <code>to</code> slot of this event.
       @param id The container identifier of the container where the
       agent migrated.
    */
    public void setTo(ContainerID id) {
	to = id;
    }

    /**
       Retrieve the value of the <code>to</code> slot of this
       event, containing the container identifier of the container
       where the agent migrated.
       @return The value of the <code>to</code> slot, or
       <code>null</code> if no value was set.
    */
    public ContainerID getTo() {
	return to;
    }


}