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

using AgentService.Ontology;

using AgentService.Platform.AMS;
using AgentService.Platform.MTS;
using AgentService.Agent.Runtime;


namespace AgentService.Agent.Runtime
{
	/// <summary>
	/// Class ConversationBody. Defines the Body of the messages used by the Conversation class
	/// to control the conversation life-cycle
	/// </summary>
    [Serializable]
    [DataContract]
	public class ConversationBody:MessageBody
	{

        public string ConvId
        {
            get
            {
                return (string)this["Guid"];
            }
        }

		/// <summary>
		/// Gets, sets the meaning of the conversation body.
		/// </summary>
		public ConversationProtocol Verb
		{
			get
			{
				return (ConversationProtocol) this["Verb"];
			}

			set
			{
				this["Verb"] = value;
			}
		}

		/// <summary>
		/// Gets, sets the initiator of the conversation
		/// </summary>
		public AID Initiator 
		{
			get
			{
				return (AID) this["Initiator"];
			}

			set
			{
				this["Initiator"] = value;
			}	
		}

        public OntologyTypeDescriptor Ontology
        {
            get
            {
                return (OntologyTypeDescriptor)this["Ontology"];
            }

            set
            {
                this["Ontology"] = value;
            }
        }

		/// <summary>
		/// Constructs an empty ConverationBody object<br/>
		/// Note: do not call this constructor, used only
		///		  for deserialization
		/// </summary>
		public ConversationBody()
		{
			this.Add("Verb", ConversationProtocol.Propose);
			this.Add("Initiator",new AID());
            this.Add("Ontology", new OntologyTypeDescriptor());
            this.Add("Guid", System.Guid.NewGuid().ToString());
        }

		/// <summary>
		/// Deserialization constructor
		/// </summary>
		/// <param name="info">SerializationInfo to populate with data</param>
		/// <param name="context">contextual information about the source or destination of the serialization</param>
		public ConversationBody(SerializationInfo info, StreamingContext context):base(info,context)
		{
		}

		/// <summary>
		/// Constructs a ConversationBody object with the given identifier and sets the conversation verb to "Conversation.Propose".
		/// </summary>
		/// <param name="original">original identifier that started the conversation set up protocol</param>
		/// <param name="identifier">conversation identifier</param>
		/// <param name="aid">aid of the initiator of the conversation</param>
		public ConversationBody(string guid, AID aid)
		{
			this.Add("Verb", ConversationProtocol.Propose);
			this.Add("Initiator",aid);
            this.Add("Ontology", new OntologyTypeDescriptor());
            this.Add("Guid", guid);
		}
		
		/// <summary>
		/// Constructs a ConversationBody object with the given identifier and the conversation verb.
		/// </summary>
		/// <param name="original">original identifier that started the conversation set up protocol</param>
		/// <param name="identifier">conversation identifier</param>
		/// <param name="verb">conversation verb</param>
		/// <param name="aid">aid of the initiator of the conversation</param>
        public ConversationBody(string guid, AID aid, ConversationProtocol verb) 
		{
			this.Add("Verb", verb);
			this.Add("Initiator",aid);
            this.Add("Ontology", new OntologyTypeDescriptor());
            this.Add("Guid", guid);
		}

        /// <summary>
        /// Constructs a ConversationBody object with the given identifier, the conversation protocol, and the alternate identifier.
        /// </summary>
        /// <param name="original">original identifier that started the conversation set up protocol</param>
        /// <param name="identifier">conversation identifier</param>
        /// <param name="verb">conversation verb</param>
        /// <param name="alternate">alternate conversation identifier</param>
        /// <param name="aid">aid of the initiator of the conversation</param>
        /// <param name="ontology">the name of the ontology</param>
        public ConversationBody(string guid, AID aid, ConversationProtocol verb, OntologyTypeDescriptor ontology)
        {
            this.Add("Verb", verb);
            this.Add("Initiator", aid);
            this.Add("Ontology", ontology);
            this.Add("Guid", guid);
        }
	}
}