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

using AgentService.Platform.AMS;
using AgentService.Platform.MTS;
using AgentService.Platform.Modules;


namespace AgentService.Platform
{
	/// <summary>
	/// Interface IModuleController. Manages the operation 
	/// with the modules exposed by the platform ocntroller.
	/// </summary>
	public interface IModuleController
	{

		#region Storage

		IModuleInfo[] GetInstalledModules(bool bAdditional);

		/// <summary>
		/// Gets all the Assembly contained in the repository
		/// </summary>
		/// <returns>List of assemblies</returns>
		AssemblyName[] GetStoredAssemblies();

		/// <summary>
		/// Gets the list of the stored AgentTemplate types
		/// used to instantiate agents.
		/// </summary>
		/// <returns>an array containing a AgentTemplateDescriptor object for each AgentTemplate</returns>
		AgentTemplateDescriptor[] GetStoredAgentTemplates();
		
		/// <summary>
		/// Gets the list of the stored Behaviour types
		/// used to instantiate agents.
		/// </summary>
		/// <returns>an array containing a BehaviourDescriptor object for each Behavoiur</returns>
		BehaviourDescriptor[] GetStoredBehaviours();

		/// <summary>
		/// Gets the list of the stored Knowledge types
		/// used to instantiate agents.
		/// </summary>
		/// <returns>an array containing a KnowledgeDescriptor object for each Knowledge</returns>
		KnowledgeDescriptor[] GetStoredKnowledges();

		/// <summary>
		/// Uploads an assembly to the platform's storage
		/// </summary>
		/// <param name="asmPath">path to the assembly</param>
		/// <returns>null if successfull a description of the error otherwise</returns>
		IModuleError UpLoadAssembly(string asmPath, bool bReplaceIfExists); 

		/// <summary>
		/// Uploads an assembly to the platform's storage
		/// </summary>
		/// <param name="asmPath">path to the assembly</param>
		/// <returns>null if successfull a description of the error otherwise</returns>
	    IModuleError RemoveAssembly(string asmPath);


		#endregion

		#region Logging
		/// <summary>
		/// Gets the log file of an agent.
		/// </summary>
		/// <param name="aid">AID identifing the agent</param>
		/// <returns>content of the log</returns>
		string GetLogFile(AID aid);

		#endregion

        #region Messaging
        /// <summary>
        /// Gets a collection of filtered messages
        /// </summary>
        /// <param name="aid">aid of the agent</param>
        /// <param name="filter">filter criteria</param>
        /// <returns>list of filtered messages</returns>
        AgentMessageCollection FilterMessage(AID aid, MessageFilter filter);
        /// <summary>
        /// Clears all the messages in the storage.
        /// </summary>		
        void ClearAllMessages();
        /// <summary>
        /// Clears all the messages in the storage for a given agent.
        /// </summary>
        /// <param name="aid">AID identifing the agent</param>
        /// <returns>true, if the process is successful</returns>
        bool ClearAllMessages(AID aid);
        #endregion

	}
}