using System;

using AgentService.Agent;
using AgentService.Agent.Runtime;
using AgentService.Agent.Behaviour;
using AgentService.Agent.Knowledge;

using AgentService.Platform.AMS;


namespace TestMessaging
{
    /// <summary>
    /// Knowledge ConvData. Mantains 
    /// information about a conversation
    /// among two agents.
    /// </summary>
    public class ConvData : Knowledge
    {
        #region Getter and Setter
        
        /// <summary>
        /// Getter for the PeerName property. The PeerName is
        /// used to store the name of the peer agent in a 
        /// conversation.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("PeerName", typeof(string), true)]
        public string GetPeerName(Behaviour lockingBehaviour)
        {
            return this["PeerName", lockingBehaviour] as string;

        }
        /// <summary>
        /// Setter for the PeerName property. The PeerName is
        /// used to store the name of the peer agent in a 
        /// conversation.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <param name="value">the property value.</param>
        /// <returns>the new property value.</returns>
        [KnowledgeItem("PeerName", typeof(string), false)]
        public string SetPeerName(Behaviour lockingBehaviour, string value)
        {
            this["PeerName", lockingBehaviour] = value;
            return this["PeerName", lockingBehaviour] as string;

        }
        
        /// <summary>
        /// Getter for the Repetitions property. The Repetitions is
        /// used to store the number of conversations attempted to
        /// open.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("Repetitions", typeof(int), true)]
        public int GetRepetitions(Behaviour lockingBehaviour)
        {
            return (int) this["Repetitions", lockingBehaviour];

        }
        /// <summary>
        /// Setter for the Repetitions property. The Repetitions is
        /// used to store the number of conversations attempted to
        /// open.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("Repetitions", typeof(int), false)]
        public int SetRepetitions(Behaviour lockingBehaviour, int value)
        {
            this["Repetitions", lockingBehaviour] = value;
            return (int) this["Repetitions", lockingBehaviour];

        }
        
        /// <summary>
        /// Getter for the MaxMessages property. he MaxMessages is
        /// used to store the number of messages sent within a 
        /// conversation.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("MaxMessages", typeof(int), true)]
        public int GetMaxMessages(Behaviour lockingBehaviour)
        {
            return (int) this["MaxMessages", lockingBehaviour];

        }
        /// <summary>
        /// Setter for the MaxMessages property. The MaxMessages is
        /// used to store the number of messages sent within a 
        /// conversation.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("MaxMessages", typeof(int), false)]
        public int SetMaxMessages(Behaviour lockingBehaviour, int value)
        {
            this["MaxMessages", lockingBehaviour] = value;
            return (int) this["MaxMessages", lockingBehaviour];

        }


        /// <summary>
        /// Getter for the Refuse property. The Refuse flag to
        /// control conversation acceptance or refusal.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("Refuse", typeof(bool), true)]
        public bool GetRefuse(Behaviour lockingBehaviour)
        {
            return (bool) this["Refuse", lockingBehaviour];

        }
        /// <summary>
        /// Setter for the Refuse property. The Refuse flag to
        /// control conversation acceptance or refusal.
        /// </summary>
        /// <param name="lockingBehaviour">Instance of the behaviour 
        /// that requests the access.</param>
        /// <returns>the property value.</returns>
        [KnowledgeItem("Refuse", typeof(int), false)]
        public bool SetRefuse(Behaviour lockingBehaviour, bool value)
        {
            this["Refuse", lockingBehaviour] = value;
            return (bool) this["Refuse", lockingBehaviour];

        }
        #endregion

        /// <summary>
        /// Deserialization constructor.
        /// </summary>
        public ConvData() 
        { 
        
        }
        /// <summary>
        /// Creates an instance of the ConvData knowledge.
        /// </summary>
        /// <param name="name">knowledge name</param>
        /// <param name="pMode">persistence mode</param>
        /// <param name="peerName">name of the peer agent</param>
        /// <param name="repetitions">number of conversations that will be openened</param>
        /// <param name="maxMessages">number of messages sent within a conversation</param>
        /// <param name="bRefuse">refuse conversation flag</param>
        public ConvData(string name, PersistenceMode pMode, string peerName, int repetitions, int maxMessages, bool bRefuse) : base(name, pMode)
        {
            this.AddItem("PeerName", typeof(string), peerName);
            this.AddItem("Repetitions", typeof(int), repetitions);
            this.AddItem("MaxMessages", typeof(int), maxMessages);
            this.AddItem("Refuse", typeof(bool), bRefuse);
        }

    }
}