/*********************************************************************/
/*                                                                   */
/*                     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;
using AgentService.Agent;

namespace AgentService.Platform.Modules
{
	/// <summary>
	/// Interface IStorageModule. Defines the basic functionalities
	/// of the module that handles the assembly storage system.
	/// </summary>
	public interface IStorageModule : IPlatformModule
	{
		/// <summary>
		/// Clear all the content of the storage.
		/// Warning this operation is dangerous since is 
		/// meant to delete all the assemblies that are 
		/// contained in the storage system.
		/// </summary>
		/// <returns>true if the operation has been successfull, false otherwise</returns>
		bool ClearStorage();

		/// <summary>
		/// Adds an assembly to the storage subsystem and 
		/// associates it to a name.
		/// </summary>
		/// <param name="path">path to the file that locates the assembly.</param>
		/// <returns>true if the assembly has been properly added to the storage, false if some error occurred.</returns>
		bool AddAssembly(string path, bool bReplaceIfExists);

		/// <summary>
		/// Removes an assembly from the storage.
		/// </summary>
		/// <param name="name">the name that identifies the assembly provided with the add method.</param>
		/// <returns>true if the assembly ahs been properly removed from the storage.</returns>
		bool RemoveAssembly(string name);

		/// <summary>
		/// Executes a copy of an assembly mantained in the storage.
		/// </summary>
		/// <param name="fileName">assembly file name</param>
		/// <param name="newPath">destination path</param>
		/// <returns>true if the copy is successfull</returns>
		bool CopyAssembly(string name, string newPath);

		/// <summary>
		/// Retrieves the assembly name where the given AgentService type (AgentTemplate,
		/// Beaviour, Knowledge).
		/// </summary>
		/// <param name="template">reference to an AgentTemplate.</param>
		/// <returns>the name of the assembly containig th agent definition.</returns>
		TypeDescriptor GetAssemblyFor(string template);

		/// <summary>
		/// Retrieves all the dependent assemblies of the given assembly.
		/// </summary>
		/// <param name="assemblyName">name of the assembly to look for.</param>
		/// <returns>arry of AssemblyName that contains the names of the dependent assemblies.</returns>
		System.Reflection.AssemblyName[] GetDependentAssemblies(string assemblyName);

		/// <summary>
		/// Synchronizes the storage phisical content with repository of AgentTemplate types.
		/// Note: Call after AddAssembly, RemoveAssembly.
		/// </summary>
		/// <returns>true if the synchronization is successful</returns>
		bool Synchronize();

		/// <summary>
		/// returns all the assemblies that the platform uses.
		/// </summary>
		System.Reflection.AssemblyName[] GetStoredAssemblies();

		/// <summary>
		/// Gets all the templates stored in the assembly loaded into the platform.
		/// </summary>
		/// <returns>a descriptor of the type containing the full type name and
		/// the assembly information</returns>
		TypeDescriptor[] GetStoredAgentTemplates();

        /// <summary>
		/// Gets all the Behaviour classes used by agents into the platform.
		/// </summary>
		/// <returns>a descriptor of the type containing the full type name and
		/// the assembly information</returns>
		TypeDescriptor[] GetStoredBehaviours();

		/// <summary>
		/// Gets all the Knowledge classes used by agents into the platform.
		/// </summary>
		/// <returns>a descriptor of the type containing the full type name and
		/// the assembly information</returns>
		TypeDescriptor[] GetStoredKnowledges();
	}
}