/*********************************************************************/
/*                                                                   */
/*                     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.DF;

namespace AgentService.Agent.Runtime
{
    /// <summary>
    /// This class represents the content of a message exchanged by two DFs.
    /// </summary>
    [Serializable]
    public class DFBodyMessage
    {
        /// <summary>
        /// The unique identifyier of the transaction.
        /// </summary>
        public Guid TransactionID
        {
            get;
            set;
        }

        /// <summary>
        /// The message type.
        /// </summary>
        public DFMessageType MessageType
        {
            get;
            set;
        }

        /// <summary>
        /// The list of returned AgentDescriptions.
        /// </summary>
        public DFAgentDescription[] AgentDescriptions
        {
            get;
            private set;

        }

        /// <summary>
        /// The searched service description
        /// </summary>
        public ServiceDescription ServiceDescription
        {
            get;
            private set;
        }

        /// <summary>
        /// Service comparison
        /// </summary>
        public ServiceComparison ServiceComparison
        {
            get;
            private set;
        }

        /// <summary>
        /// The search constraints
        /// </summary>
        public SearchConstraints SearchConstraints
        {
            get;
            private set;
        }

        /// <summary>
        /// The search type
        /// </summary>
        public SearchAgentType SearchType
        {
            get;
            private set;
        }

        /// <summary>
        /// Constructs a new DF body message and instantiate a new TransactionID
        /// </summary>
        public DFBodyMessage()
        {
            this.MessageType = DFMessageType.Reply;
            this.TransactionID = Guid.NewGuid();
        }

        /// <summary>
        /// Set the required field for a search.
        /// </summary>
        /// <param name="sd">The service description</param>
        /// <param name="constraints">The service constraints</param>
        public void SearchAgent(ServiceDescription sd, SearchConstraints constraints)
        {
            this.MessageType = DFMessageType.Query;
            this.SearchType = SearchAgentType.ServiceAndConstraints;
            this.ServiceDescription = sd;
            this.SearchConstraints = constraints;
        }

        /// <summary>
        /// Set the required field for a search.
        /// </summary>
        /// <param name="sd">The service description</param>
        /// <param name="constraints">The service constraints</param>
        /// <param name="flags">The flags</param>
        public void SearchAgent(ServiceDescription sd, ServiceComparison flags, SearchConstraints constraints)
        {
            this.MessageType = DFMessageType.Query;
            this.SearchType = SearchAgentType.ServiceFlagsAndConstraints;
            this.ServiceDescription = sd;
            this.SearchConstraints = constraints;
            this.ServiceComparison = flags;
        }

        /// <summary>
        /// Sets the reply to a query
        /// </summary>
        /// <param name="agents">The list of agents</param>
        /// <param name="transactionID">The transaction ID</param>
        public void setReply(DFAgentDescription []agents, Guid transactionID)
        {
            this.TransactionID = transactionID;
            this.AgentDescriptions = agents;
            this.MessageType = DFMessageType.Reply;
        }

    }

    /// <summary>
    /// States the type of message
    /// </summary>
    public enum DFMessageType
    {
        Query, Reply
    }

    /// <summary>
    /// States the type of search.
    /// </summary>
    public enum SearchAgentType
    {
        ServiceAndConstraints, ServiceFlagsAndConstraints
    }
}