/*********************************************************************/
/*                                                                   */
/*                     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 System.Reflection;

namespace AgentService.Platform.Modules
{
	/// <summary>
	/// Enum StorageActions. Defines all the
	/// possible requests that can be issued 
	/// to the storage module.
	/// </summary>
	public enum StorageActions 
	{
		/// <summary>
		/// Identifies the request of adding an
		/// assembly to the platform storage.
		/// </summary>
		AddAssembly,
		/// <summary>
		/// Identifies the request of copying an
		/// assembly from the storage
		/// </summary>
		CopyAssembly,
		/// <summary>
		/// Identifies the request of removing an
		/// assembly to the platform storage.
		/// </summary>
		RemoveAssembly,
		/// <summary>
		/// Identifies the request of a list of
		/// all the templates stored in the storage.
		/// </summary>
		QueryTemplates,
		/// <summary>
		/// Identifies the request of a list of
		/// assemblies stored in the storage.
		/// </summary>
		QueryAssemblies,
		/// <summary>
		/// Identifies the request of a list of
		/// all the knowledge types stored in the
		/// storage.
		/// </summary>
		QueryKnowledges,
		/// <summary>
		/// Identifies the request of a list of
		/// all the behaviour types stored in the
		/// storage.
		/// </summary>
		QueryBehaviours,
		/// <summary>
		/// Identifies the request of a type information
		/// abobut a given type.
		/// </summary>
		QueryType
	}

	/// <summary>
	/// Class StorageSinkEvent. Wraps all possible events
	/// that can be processed by the storage module.
	/// </summary>
	public class StorageSinkEvent : PlatformSinkEvent 
	{

		/// <summary>
		/// action selected
		/// </summary>
		private StorageActions action;
		/// <summary>
		/// Gets, sets the selected action.
		/// </summary>
		public StorageActions Action 
		{
			get 
			{
				return this.action;
			}
			set 
			{
				this.action = value;
			}
		}
		/// <summary>
		/// optional parameter
		/// </summary>
		private string param;
		/// <summary>
		/// Gets, sets the optional parameter
		/// used to process the event.
		/// </summary>
		public string  Param 
		{
			get 
			{
				return this.param;
			}
			set 
			{
				this.param = value;
			}
		}

		/// <summary>
		/// second optional parameter. Used only in CopyAssembly event to
		/// specify the path where to copy assembly
		/// </summary>
		private string param2;
		/// <summary>
		/// Gets, sets the optional second parameter
		/// used to process the event.
		/// </summary>
		public string Param2 
		{
			get 
			{
				return this.param2;
			}
			set 
			{
				this.param2 = value;
			}
		}

		/// <summary>
		/// array of type descriptor objects
		/// </summary>
		private TypeDescriptor[] types;
		/// <summary>
		/// Gets, sets the list of type descriptors.
		/// This field is not null when the event is
		/// related to QueryXXX (except QueryAssemblies)
		/// actions.
		/// </summary>
		public TypeDescriptor[] Types 
		{
			get 
			{
				return this.types;
			}
			set 
			{
				this.types = value;
			}
		}
		/// <summary>
		/// list of assemblies hold by the
		/// storage.
		/// </summary>
		private AssemblyName[] assemblies;
		/// <summary>
		/// Gets, sets the list of assembly
		/// hold by the storage.(Not null only
		/// in case of a QueryAssemblies action).
		/// </summary>
		public AssemblyName[] Assemblies 
		{
			get 
			{
				return this.assemblies;
			}
			set 
			{
				this.assemblies = value;
			}
		}
		/// <summary>
		/// Constructs a StorageSinkEvent instance for the copy assembly action.
		/// </summary>
		/// <param name="action">selected action</param>
		/// <param name="param">parameter needed to perform the action: name of the assembly to copy</param>
		/// <param name="param2">parameter needed to perform the action: new path of the copied assembly</param>
		public StorageSinkEvent(StorageActions action, string param, string param2) 
		{
			this.action = action;
			this.param = param;
			this.param2 = param2;
		}
		
		/// <summary>
		/// Constructs a StorageSinkEvent instance.
		/// </summary>
		/// <param name="action">selected action</param>
		/// <param name="param">parameter needed to perform the action</param>
		public StorageSinkEvent(StorageActions action, string param) 
		{
			this.action = action;
			this.param = param;
		}
		/// <summary>
		/// Constructs a StorageSinkEvent instance.
		/// </summary>
		/// <param name="action">selected action</param>
		public StorageSinkEvent(StorageActions action) 
		{
			this.action = action;
		}

		/// <summary>
		/// Gets a descriptor for this event.
		/// </summary>
		/// <returns>Descriptor of the event</returns>
		public static EventSinkDescriptor GetDescriptor() 
		{
			EventSinkDescriptor descriptor = new EventSinkDescriptor("StorageSinkEvent", typeof(StorageSinkEvent));
			return descriptor;
		}

	}

}