/*********************************************************************/
/*                                                                   */
/*                     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 AgentService.Platform;
//using AgentService.Platform.Modules;
using AgentService.Platform.Commands;

namespace AgentService.Platform 
{


	/// <summary>
	/// Class PlatformCustomEventargs. Defines the event argument for all the handlers
	/// that will be attached to the platform context.
	/// </summary>
	public class PlatformEventArgs 
	{
		/// <summary>
		/// type of the event
		/// </summary>
		private PlatformEvent type;
		/// <summary>
		/// Gets the type of the event
		/// </summary>
		public PlatformEvent Type 
		{
			get 
			{
				return this.type;	
			}
		}

		/// <summary>
		/// name of the event, in case of
		/// custom events, the name distinguish
		/// the type of the event
		/// </summary>
		private string name;
		/// <summary>
		/// Gets the name of the event
		/// </summary>
		public string Name 
		{
			get 
			{
				return this.name;
			}
		}
        /// <summary>
        /// additional event data
        /// </summary>
        protected object data;
        /// <summary>
        /// Gets the additional data
        /// attached to the event
        /// </summary>
        public object Data 
        {
            get 
            {
                return this.data;
            }
        }
        /// <summary>
        /// Constructs a PlatformEventArgsobject by specifying the 
        /// given PlatformEvent.
        /// </summary>
        /// <param name="type">declares the type of the event</param>
        /// <param name="name">name of the event</param>
        public PlatformEventArgs(PlatformEvent type, string name)
        {
            this.type = type;
            switch (this.type)
            {
                case PlatformEvent.AgentCreated: this.name = "AgentCreated"; break;
                case PlatformEvent.AgentPersisted: this.name = "AgentPersisted"; break;
                case PlatformEvent.AgentStopped: this.name = "AgentStopped"; break;
                case PlatformEvent.AgentResumed: this.name = "AgentResumed"; break;
                case PlatformEvent.AgentWokenUp: this.name = "AgentWokenUp"; break;

                case PlatformEvent.AssemblyRemoved: this.name = "AssemblyRemoved"; break;
                case PlatformEvent.AssemblyUploaded: this.name = "AssemblyUploaded"; break;

                case PlatformEvent.ConversationRequested: this.name = "ConversationRequested"; break;
                case PlatformEvent.ConversationAccepted: this.name = "ConversationAccepted"; break;
                case PlatformEvent.ConversationRefused: this.name = "ConversationRefused"; break;
                case PlatformEvent.ConversationClosed: this.name = "ConversationClosed"; break;
                case PlatformEvent.MessageSent: this.name = "MessageSent"; break;
                case PlatformEvent.MessageReceived: this.name = "MessageReceived"; break;
                case PlatformEvent.MessageBatch: this.name = "MessageBatch"; break;

                default:
                    {
                        // custom events
                        this.name = name;
                    } break;
            }

        }
		/// <summary>
		/// Constructs a PlatformEventArgsobject by specifying the 
		/// given PlatformEvent and the additional data attached to
        /// the event.
		/// </summary>
		/// <param name="type">declares the type of the event</param>
		/// <param name="name">name of the event</param>
        /// <param name="data">additional data</param>
		public PlatformEventArgs(PlatformEvent type, string name, object data) : this(type, name)
		{
            this.data = data;
		}
	}


	/// <summary>
	/// Enum PlatformEvent. enumeration of possible
	/// platform events
	/// </summary>
	public enum PlatformEvent 
	{
		/// <summary>
		/// Identifies the OnAgentCreated event
		/// </summary>
		AgentCreated,
		/// <summary>
		/// Identifies the OnAgentResumed event
		/// </summary>
		AgentResumed,
		/// <summary>
		/// Identifies the OnAgentStopped event
		/// </summary>
		AgentStopped,
		/// <summary>
		/// Identifies the OnAgentWokenUp event
		/// </summary>
		AgentWokenUp,
		/// <summary>
		/// Identifies the OnAgentPersisted event
		/// </summary>
		AgentPersisted,
		/// <summary>
		/// Identifies the OnMessageBatch event
		/// </summary>
		MessageBatch,
		/// <summary>
		/// Identifies the OnMessageSent event
		/// </summary>
		MessageSent,
		/// <summary>
		/// Identifies the OnMessageReceived event
		/// </summary>
		MessageReceived,
		/// <summary>
		/// Identifies the OnConversationRequested event
		/// </summary>
		ConversationRequested,
		/// <summary>
		/// Identifies the OnConversationAccepted event
		/// </summary>
		ConversationAccepted,
		/// <summary>
		/// Identifies the OnConversationRefused event
		/// </summary>
		ConversationRefused,
		/// <summary>
		/// Identifies the OnConversationClosed event
		/// </summary>
		ConversationClosed,
		/// <summary>
		/// Identifies the OnAssemblyRemoved event
		/// </summary>
		AssemblyRemoved,
		/// <summary>
		/// Identifies the OnAssemblyUploaed event
		/// </summary>
		AssemblyUploaded,
		/// <summary>
		/// Identifies custom events
		/// </summary>
		Custom
	}



	/// <summary>
	/// Delegate PlatformEventHandler. Defines the common event handler for all the 
	/// events defined in the IPlatformContext interface.
	/// </summary>
	public delegate void PlatformEventHandler(object sender, PlatformEventArgs args);	
	
}