///////////////////////////////////////////////////////////
//  SecurityGroupList.cs
//  Implementation of Class SecurityGroupList
//  CSLA type: Read only collection 
//  Created on: 12-Sept-2005 
//  Object design: John  
//  Coded:  12-Sept-2005  
///////////////////////////////////////////////////////////

using System;
using System.Data;
using GZTW.Data;
using CSLA.Data;
using CSLA;

namespace GZTW.AyaNova.BLL 
{
#pragma warning disable 1591



	/// <summary>
    /// Read only list of <see cref="SecurityGroupList.SecurityGroupListInfo"/> objects representing <see cref="SecurityGroup"/> objects.
    /// Used for reporting and UI Grid display.
	/// </summary>
	[Serializable]
	public class SecurityGroupList : ReadOnlyCollectionBase 
	{		
		#region Data structure
		/// <summary>
		/// Properties
		/// </summary>
		[Serializable]
			public struct SecurityGroupListInfo 
		{			
			internal GridNameValueCellItem mName;	//and ID     



                [SqlColumnNameAttribute("aSecurityGroup.aName",
                            "aSecurityGroup.aID")]
			public GridNameValueCellItem LT_O_SecurityGroup
			{
				get
				{
					return mName;
				}
			}

			

			

			/// <summary>
			///
			/// </summary>
			/// <param name="obj"></param>
			public bool Equals(SecurityGroupListInfo obj)
			{
				return this.mName.Value.Equals(obj.mName.Value);
			}

		}//end SecurityGroupListInfo
		#endregion

		#region Constructor

		protected SecurityGroupList()
		{
			//			AllowSort=false;
			//			AllowFind=true;
			//			AllowEdit=false;
			//			AllowNew=false;
			//			AllowRemove=false;
		}

		#endregion
		
		#region Business properties and methods

		/// <summary>
		/// Get item by index
		/// </summary>
		/// <param name="Item"></param>
		public SecurityGroupListInfo this[int Item]
		{

			get
			{
				return (SecurityGroupListInfo) List[Item];
			}
		}


		/// <summary>
		/// Returns display text that matches passed in itemid value
		/// </summary>
		/// <param name="ItemID"></param>
		public string this[Guid ItemID]
		{

			get
			{
				foreach (SecurityGroupListInfo child in List)
				{
					if(child.mName.Value==ItemID) return child.ToString();
				}
				return "Missing: "+ItemID.ToString();
			}
		}

		/// <summary>
		/// Returns display text that matches passed in group name value
		/// </summary>
		/// <param name="Name">Name of security group</param>
		public string this[string Name]
		{

			get
			{
				foreach (SecurityGroupListInfo child in List)
				{
					if(child.mName.Display==Name) return child.mName.Value.ToString();
				}
				return "Missing: "+Name;
			}
		}
		#endregion

		#region contains
		/// <summary>
		/// Check if item in collection
		/// </summary>		
		/// <param name="obj"></param>
		public bool Contains(SecurityGroupListInfo obj)
		{
			foreach (SecurityGroupListInfo child in List)
			{
				if(child.Equals(obj)) return true;
			}
			return false;

		}
		#endregion

		#region Static methods		
		/// <summary>
		/// Get list by criteria
		/// </summary>
		/// <param name="xmlCriteria">Use AyaNova UI to easily build xmlCriteria and Ctrl-Alt-g keyboard command to display it for use in your code</param>
        /// <returns>list of <see cref="SecurityGroupList.SecurityGroupListInfo"/> objects</returns>	
		public static SecurityGroupList GetList(string xmlCriteria)
		{
			return (SecurityGroupList) DataPortal.Fetch(new Criteria(xmlCriteria));
		}

		

		/// <summary>
		/// Return an empty list
		/// used for initializing grid
		/// </summary>
		/// <returns></returns>
		public static SecurityGroupList GetEmptyList()
		{
			return new SecurityGroupList();
		}


		#endregion

		#region DAL DATA ACCESS
		/// 
		/// <param name="Criteria"></param>
		protected override void DataPortal_Fetch(object Criteria)
		{
			
			Criteria crit = (Criteria)Criteria;	
	
			SafeDataReader dr = null;	
			try
			{			
				dr=DBUtil.GetReaderFromSQLString(
					//************************************************************
					"SELECT aSecurityGroup.aID, aSecurityGroup.aName " +
					"FROM aSecurityGroup " +
					AyaBizUtils.GetGridColumnCriteria(crit.CriteriaXML,true) + " " + 
					AyaBizUtils.GetGridSortOrderColumns(crit.CriteriaXML)
					//************************************************************
					);			
				
				while(dr.Read()) 
				{
					//*******************************************
					SecurityGroupListInfo info=new SecurityGroupListInfo();
					info.mName=new GridNameValueCellItem(
						dr.GetGuid("aID"),
						dr.GetString("aName"),
						RootObjectTypes.SecurityGroup);
					InnerList.Add(info);
					//*******************************************
				}
			}
			finally
			{
				if(dr!=null) dr.Close();
			}	

			
		}
		#endregion		

		#region criteria
		/// <summary>
		/// Criteria for identifying existing object
		/// </summary>
		[Serializable]
			private class Criteria
		{

						
			public string CriteriaXML;	
			
			public Criteria( string _CriteriaXML)
			{					
				CriteriaXML=_CriteriaXML;					
				
			}
			
		}
		#endregion
		
	}//end SecurityGroupList
#pragma warning restore 1591
}//end namespace GZTW.AyaNova.BLL