/*********************************************************************/
/*                                                                   */
/*                     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.Agent;
// this namespace contains the elements for the instantiation
// of new knowledges.
using AgentService.Agent.Knowledge;
// this namespac contains the elements for the instantiation
// of new behaviours.
using AgentService.Agent.Behaviour;

namespace AuctionDemo
{
    
	/// <summary>
    /// The AuctionData knowledge maintains information about an auction 
    /// session (i.e. the object, the starting price, the minimum increase, 
    /// and the expected number of bidders.
	/// </summary>
	[Serializable]
	public class AuctionData : AgentService.Agent.Knowledge.Knowledge
	{
		/// <summary>
		/// Deserialization constructor.
		/// </summary>
		public AuctionData() : base()
		{
		}
		/// <summary>
		/// Constructor with parameters
		/// </summary>
		/// <param name="name">the name of the knowledge instance</param>
		/// <param name="pMode">persistence mode</param>
		/// <param name="item">the name of the object</param>
		/// <param name="price">initial price of the object</param>
		/// <param name="minIncrement">minumum increase</param>
		/// <param name="maxParticipants">expected number of bidders</param>
		public AuctionData(string name, PersistenceMode pMode, string item, float price, float minIncrement, int maxParticipants):base(name, pMode)
		{
			this.AddItem("Item",typeof(string),item);
			this.AddItem("Price",typeof(float),price);
			this.AddItem("MinIncrement", typeof(float), minIncrement);
			this.AddItem("MaxParticipants", typeof(int), maxParticipants);
		}
		
		#region Getter and Settere for the properties of the knowledge
		/// <summary>
		/// The Getter for the Item property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <returns>the property value.</returns>
		[KnowledgeItem("Item",typeof(string),true)]
		public string GetItem(Behaviour lockingBehaviour)
		{	
			return this["Item", lockingBehaviour] as string;
		
		}
		/// <summary>
		/// Setter for the Item property
		/// </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("Item", typeof(string), false)]
		public string SetItem(Behaviour lockingBehaviour, string value)
		{
			this["Item", lockingBehaviour] = value;
			return this["Item", lockingBehaviour] as string;
		
		}
		/// <summary>
		/// Getter for the Price property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <returns>the property value of Price</returns>
		[KnowledgeItem("Price",typeof(float), true)]
		public float GetPrice(Behaviour lockingBehaviour)
		{	
			return (float) this["Price", lockingBehaviour];
		
		}
		/// <summary>
		/// Setter for the Price property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <param name="value">the property value of the Price</param>
		/// <returns>the new value of the property Price</returns>
		[KnowledgeItem("Price",typeof(float), false)]
		public float SetPrice(Behaviour lockingBehaviour, float value)
		{
			this["Price", lockingBehaviour] = value;
			return (float) this["Price", lockingBehaviour];
		
		}
		/// <summary>
		/// Getter for the MinIncrement property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <returns>the value of MinIncrement</returns>
		[KnowledgeItem("MinIncrement",typeof(float),true)]
		public float GetMinIncrement(Behaviour lockingBehaviour)
		{	
			return (float) this["MinIncrement", lockingBehaviour];
		
		}
		/// <summary>
		/// Setter for the MinIncrement property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <param name="value">the value of MinIncrement</param>
		/// <returns>the new value</returns>
		[KnowledgeItem("MinIncrement",typeof(float),false)]
		public float SetMinIncrement(Behaviour lockingBehaviour, float value)
		{
			this["MinIncrement", lockingBehaviour] = value;
			return (float) this["MinIncrement", lockingBehaviour];
		
		}		
		/// <summary>
		/// Getter for the MaxParticipants property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <returns>value of MaxParticipants</returns>
		[KnowledgeItem("MaxParticipants",typeof(int),true)]
		public int GetMaxParticipants(Behaviour lockingBehaviour)
		{	
			return (int) this["MaxParticipants", lockingBehaviour];
		
		}
		/// <summary>
		/// Setter for the MaxParticipants property.
		/// </summary>
		/// <param name="lockingBehaviour">Instance of the behaviour that requests the access.</param>
		/// <param name="value">the new value</param>
		/// <returns>the current value</returns>
		[KnowledgeItem("MaxParticipants",typeof(int),false)]
		public int SetMaxParticipants(Behaviour lockingBehaviour, int value)
		{
			this["MaxParticipants", lockingBehaviour] = value;
			return (int) this["MaxParticipants", lockingBehaviour];
		
		}		
		#endregion

	}
}