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

namespace AgentService.Platform.Modules
{
    /// <summary>
    /// The delegate for the function that manages an IncomingMessage event.
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="args"></param>
    public delegate void IncomingMessage(object sender, IncomingMessageEventArgs args);

    /// <summary>
    /// The delegate for the function that manages an IncomingConversation event.
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="args"></param>
    public delegate void IncomingConversation(object sender, IncomingConversationEventArgs args);

    /// <summary>
    /// The delegate for the function that manages an IncomingConversationMessage event.
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="args"></param>
    public delegate void IncomingConversationMessage(object sender, IncomingConversationMessageEventArgs args);
   
    /// <summary>
    /// The interface for the improved messaging module.
    /// </summary>
    public interface IImprovedMessagingModule
    {
        /// <summary>
        /// This method allows an external Message Client to register itself
        /// to the event raised when a message is added to a queue.
        /// </summary>
        /// <param name="messageIncoming">The delegate</param>
        /// <param name="agent">The AID of the agent that waits for messages.</param>
        void RegisterToIncomingMessage(IncomingMessage messageIncoming, AID agent);

        /// <summary>
        /// This method allows an external Message Client to register itself
        /// to the event raised when an conversation request is incoming.
        /// </summary>
        /// <param name="conversationIncoming">The delegate</param>
        /// <param name="agent">The agent which is receiving the conversation request.</param>
        void RegisterToIncomingConversation(IncomingConversation conversationIncoming, AID agent);

        /// <summary>
        /// This method allows an external Message Client to register itself
        /// to the event raised when an conversation message is incoming.
        /// </summary>
        /// <param name="conversationIncoming">The delegate</param>
        /// <param name="agent">The agent AID.</param>
        void RegisterToIncomingConversationMessage(IncomingConversationMessage conversationIncoming, AID agent);

        /// <summary>
        /// This method allows an external Message Client to deregister itself
        /// to the event raised when a message is added to a queue.
        /// </summary>
        /// <param name="messageIncoming">The delegate</param>
        /// <param name="agent">The AID of the agent that waits for messages.</param>
        void DeregisterToIncomingMessage(IncomingMessage messageIncoming, AID agent);

        /// <summary>
        /// This method allows an external Message Client to register itself
        /// to the event raised when an conversation request is incoming.
        /// </summary>
        /// <param name="conversationIncoming">The delegate</param>
        /// <param name="agent">The agent which is receiving the conversation request.</param>
        void DeregisterToIncomingConversation(IncomingConversation conversationIncoming, AID agent);

        /// <summary>
        /// This method allows an external Message Client to register itself
        /// to the event raised when an conversation message is incoming.
        /// </summary>
        /// <param name="conversationIncoming">The delegate</param>
        /// <param name="agent">The agent AID.</param>
        void DeregisterToIncomingConversationMessage(IncomingConversationMessage conversationIncoming, AID agent);
    }
}