using System;
using System.Collections;
using System.Xml;
using System.Xml.Serialization;

//
// DotNetNuke -  http://www.dotnetnuke.com
// Copyright (c) 2002-2005
// by Shaun Walker ( sales@perpetualmotion.ca ) of Perpetual Motion Interactive Systems Inc. ( http://www.perpetualmotion.ca )
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


namespace DotNetNuke.Security.Roles
{
	
	/// -----------------------------------------------------------------------------
	/// Project:    DotNetNuke
	/// Namespace:  DotNetNuke.Security.Roles
	/// Class:      RoleInfo
	/// -----------------------------------------------------------------------------
	/// <summary>
	/// The RoleInfo class provides the Entity Layer Role object
	/// </summary>
	/// <history>
	///     [cnurse]    05/23/2005  made compatible with .NET 2.0
	/// </history>
	/// -----------------------------------------------------------------------------
	[XmlRoot("role", IsNullable=false)]
	public class RoleInfo
	{
		private int roleID;
		private int portalID;
		private string roleName;
		private string description;
		private float serviceFee;
		private string billingFrequency;
		private int trialPeriod;
		private string trialFrequency;
		private int billingPeriod;
		private float trialFee;
		private bool isPublic;
		private bool autoAssignment;
		
		/// <summary>
		/// Gets and sets the Role Id
		/// </summary>
		/// <value>An Integer representing the Id of the Role</value>
		[XmlIgnore()]
		public int RoleID
		{
			get { return this.roleID; }
			set { this.roleID = value; }
		}
		
		/// <summary>
		/// Gets and sets the Portal Id for the Role
		/// </summary>
		/// <value>An Integer representing the Id of the Portal</value>
		[XmlIgnore()]
		public int PortalID
		{
			get { return this.portalID; }
			set { this.portalID = value; }
		}
		
		/// <summary>
		/// Gets and sets the Role Name
		/// </summary>
		/// <value>A string representing the name of the role</value>
		[XmlElement("rolename")]
		public string RoleName
		{
			get { return this.roleName; }
			set { this.roleName = value; }
		}
		
		/// <summary>
		/// Gets an sets the Description of the Role
		/// </summary>
		/// <value>A string representing the description of the role</value>
		[XmlElement("description")]
		public string Description
		{
			get { return this.description; }
			set { this.description = value; }
		}
		
		/// <summary>
		/// Gets and sets the Billing Frequency for the role
		/// </summary>
		/// <value>A String representing the Billing Frequency of the Role<br/>
		/// <ul>
		/// <list>N - None</list>
		/// <list>O - One time fee</list>
		/// <list>D - Daily</list>
		/// <list>W - Weekly</list>
		/// <list>M - Monthly</list>
		/// <list>Y - Yearly</list>
		/// </ul>
		/// </value>
		[XmlElement("billingfrequency")]
		public string BillingFrequency
		{
			get { return this.billingFrequency; }
			set { this.billingFrequency = value; }
		}
		
		/// <summary>
		/// Gets and sets the fee for the role
		/// </summary>
		/// <value>A single number representing the fee for the role</value>
		[XmlElement("servicefee")]
		public float ServiceFee
		{
			get { return this.serviceFee; }
			set { this.serviceFee = value; }
		}
		
		/// <summary>
		/// Gets and sets the Trial Frequency for the role
		/// </summary>
		/// <value>A String representing the Trial Frequency of the Role<br/>
		/// <ul>
		/// <list>N - None</list>
		/// <list>O - One time fee</list>
		/// <list>D - Daily</list>
		/// <list>W - Weekly</list>
		/// <list>M - Monthly</list>
		/// <list>Y - Yearly</list>
		/// </ul>
		/// </value>
		[XmlElement("trialfrequency")]
		public string TrialFrequency
		{
			get { return this.trialFrequency; }
			set { this.trialFrequency = value; }
		}
		
		/// <summary>
		/// Gets and sets the length of the trial period
		/// </summary>
		/// <value>An integer representing the length of the trial period</value>
		[XmlElement("trialperiod")]
		public int TrialPeriod
		{
			get { return this.trialPeriod; }
			set { this.trialPeriod = value; }
		}
		
		/// <summary>
		/// Gets and sets the length of the billing period
		/// </summary>
		/// <value>An integer representing the length of the billing period</value>
		[XmlElement("billingperiod")]
		public int BillingPeriod
		{
			get { return this.billingPeriod; }
			set { this.billingPeriod = value; }
		}
		
		/// <summary>
		/// Gets and sets the trial fee for the role
		/// </summary>
		/// <value>A single number representing the trial fee for the role</value>
		[XmlElement("trialfee")]
		public float TrialFee
		{
			get { return this.trialFee; }
			set { this.trialFee = value; }
		}
		
		/// <summary>
		/// Gets and sets whether the role is public
		/// </summary>
		/// <value>A boolean (True/False)</value>
		[XmlElement("ispublic")]
		public bool IsPublic
		{
			get { return this.isPublic; }
			set { this.isPublic = value; }
		}
		
		/// <summary>
		/// Gets and sets whether users are automatically assigned to the role
		/// </summary>
		/// <value>A boolean (True/False)</value>
		[XmlElement("autoassignment")]
		public bool AutoAssignment
		{
			get { return this.autoAssignment; }
			set { this.autoAssignment = value; }
		}
	}
	
}