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


namespace AgentService.Platform.Modules
{
	/// <summary>
	/// Enum ModuleInfoState. Defines the state of a ModuleInfo object
	/// </summary>
	public enum ModuleInfoState 
	{
		/// <summary>
		/// the module is pending for installation
		/// </summary>
		New,
		/// <summary>
		/// the module is installed
		/// </summary>
		Installed,
		/// <summary>
		/// the module is pending for removal
		/// </summary>
		Removed
			
	}

	/// <summary>
	/// Interface ModuleInfo. Holds information 
	/// about a module: is name and is containing 
	/// assembly.
	/// </summary>
	public interface IModuleInfo 
	{
		/// <summary>
		/// Gets the module unique identifier
		/// </summary>
		string Key
		{
			get;
		}
		/// <summary>
		/// Gets, sets the state of the ModuleInfo object
		/// </summary>
		ModuleInfoState State 
		{
			get;
		}
		/// <summary>
		/// Gets the full name of the type that implements the module.
		/// </summary>
		string FullTypeName 
		{
			get;
		}
		/// <summary>
		/// Gets the name of the assembly contiaing the module.
		/// </summary>
		string AssemblyName 
		{
			get; 
		}
		/// <summary>
		/// Gets the configuration file of the module
		/// </summary>
		string ConfigFile
		{
			get;
		}

		/// <summary>
		/// Gets the belonging category of the module
		/// </summary>
		ModuleCategory Category 
		{ 
			get; 
		}

		/// <summary>
		/// Gets the name of the module
		/// </summary>
		string Name 
		{ 
			get; 
		}
		
		/// <summary>
		/// Gets a summary description of the module
		/// </summary>
		string Description 
		{ 
			get; 
		}

	}

}