/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* 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.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using AgentService.Agent;
using AgentService.Platform.AMS;


namespace AgentService.Platform.AMS
{
	/// <summary>
	/// MoveRequest class. Intended for platform 's internal use. It Contains
	/// all the parameters needed to transfer an agent
	/// </summary>
	[Serializable()]
	public class MoveRequest
	{
		/// <summary>
		/// AID of the agent to move
		/// </summary>
		private AID aidOfAgentToMove;
		/// <summary>
		/// Get the AID of the agent to move
		/// </summary>
		public AID AidOfAgentToMove
		{
			get
			{
				return this.aidOfAgentToMove;
			}
		}

		/// <summary>
		/// Name of the target platform
		/// </summary>
		private string destinationPlatform;
		/// <summary>
		/// Get the name of the target platform
		/// </summary>
		public string DestinationPlatform
		{
			get
			{
				return this.destinationPlatform;
			}
		}

		/// <summary>
		/// Type of the behaviour that requested the transfer of the agent
		/// </summary>
		private Type behaviourType;
		/// <summary>
		/// Get and set the behaviour's type that requested the transfer
		/// of the agent
		/// </summary>
		public Type BehaviourType
		{
			get
			{
				return this.behaviourType;
			}
			set
			{
				this.behaviourType = value;
			}
		}

		/// <summary>
		/// Name of the behaviour that requested the transfer of the agent
		/// </summary>
		private string behaviourName;
		/// <summary>
		/// Get and set the name of the behaviour that requested the 
		/// transfer of the agent
		/// </summary>
		public string BehaviourName
		{
			get
			{
				return this.behaviourName;
			}
			set
			{
				this.behaviourName = value;
			}
		}

		/// <summary>
		/// Flag that indicates if the request to move the agent was originated
		/// by the platform (i.e. load balancing motivation), or it was
		/// originated by the agent itself
		/// </summary>
		private bool bIsSystemRequest;
		/// <summary>
		/// Get the bIsSystemRequest flag.
		/// </summary>
		public bool IsSystemRequest
		{
			get
			{
				return this.bIsSystemRequest;
			}
		}

        /// <summary>
        /// Timeout value for the transfer process
        /// </summary>
        private TimeSpan timeout;
        /// <summary>
        /// Get the timeout for the transfer process
        /// </summary>
        public TimeSpan Timeout
        {
            get 
            {
                return this.timeout;
            }
        }

		/// <summary>
		/// Default constructor. It's used by binary deserialization
		/// </summary>
		public MoveRequest()
		{
			this.aidOfAgentToMove = null;
			this.destinationPlatform = string.Empty;
			this.behaviourType = null;
			this.behaviourName = string.Empty;
            this.timeout = new TimeSpan();
		}

		/// <summary>
		/// Constructor.
		/// </summary>
		/// <param name="aidOfAgentToMove">AID of the agent to move</param>
		/// <param name="destinationPlatform">Name od the target platform</param>
		public MoveRequest(AID aidOfAgentToMove, string destinationPlatform, TimeSpan timeout, bool bIsSystemRequest)
		{
			this.aidOfAgentToMove = aidOfAgentToMove;
			this.destinationPlatform = destinationPlatform;
			this.behaviourType = null;
			this.behaviourName = string.Empty;
			this.bIsSystemRequest = bIsSystemRequest;
            this.timeout = timeout;
		}
	}
}