/*********************************************************************/
/*                                                                   */
/*                     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;

namespace AgentService.Platform.Commands
{
	/// <summary>
	/// Class PlatformCommand. Abstracts a command issued to a platform.
	/// </summary>
	public abstract class PlatformCommand
	{
		/// <summary>
		/// command level
		/// </summary>
		private PlatformState state;
		/// <summary>
		/// Gets the level of the command
		/// </summary>
		public PlatformState State 
		{
			get 
			{
				return this.state;
			}
		}

		/// <summary>
		/// stores the match exact flag
		/// </summary>
		private bool bMatchExact;
		/// <summary>
		/// Gets the command behaviour, if true the command can be
		/// executed if only if the state of the platform is the same
		/// of the one specified by the command, if false the specified 
		/// command is a minimum requirement
		/// </summary>
		public bool MatchExact 
		{
			get 
			{
				return this.bMatchExact;
			}
		}

		/// <summary>
		/// Constructs a PlatformCommand object, with the state set to 
		/// PlatformState.FailStart and the match exact flag to true.
		/// </summary>
		public PlatformCommand()
		{
			this.state = PlatformState.FailStart;
			this.bMatchExact = true;
		}

		/// <summary>
		/// Constructs a PlatformCommand object of the given type.
		/// </summary>
		/// <param name="state">state of the command</param>
		/// <param name="bMatchExact">if true the command requires exactly the given state</param>
		public PlatformCommand(PlatformState state, bool bMatchExact) 
		{
			this.state = state;
			this.bMatchExact = bMatchExact;
		}

		/// <summary>
		/// Performs the command task
		/// </summary>
		/// <param name="cmdCtx">refence to the context object used by commands to perform their task</param>
		public abstract void Execute(ICommandContext cmdCtx);
		
		/// <summary>
		/// Parse the string set up the command arguments
		/// </summary>
		/// <param name="args"></param>
		/// <returns>true if the parsing has been successful</returns>
		public abstract bool ParseArguments(string args);

	}
}