/*********************************************************************/
/*                                                                   */
/*                     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.Modules
{
	/// <summary>
	/// Interface IModuleError. Contains all necessary 
	/// information about an error occurred with a
	/// module
	/// </summary>
	public interface IModuleError
	{
        /// <summary>
        /// Gets the code of the error.
        /// </summary>
        /// <remarks>Negative codes are reserved to the platform, please see ModuleErrorCodes.cs</remarks>
        int Code
        {
            get;
        }
		/// <summary>
		/// Gets a reference to a the module that
		/// originated the error
		/// </summary>
		IModuleInfo OriginatingModule 
		{
			get;
		}
		/// <summary>
		/// Gets the exception that is related to
		/// the module. If no exception caused the
		/// error returns null.
		/// </summary>
		Exception Exception 
		{
			get;
		}
		/// <summary>
		/// Gets an informative description about the
		/// error.
		/// </summary>
		string Description 
		{
			get;
		}
		/// <summary>
		/// Gets an array of messages related to the
		/// error.
		/// </summary>
		string[] Messages 
		{
			get; 
		}

	}
}