///////////////////////////////////////////////////////////
//  WorkorderQuoteList.cs
//  Implementation of Class WorkorderQuoteList
//  CSLA type: Read only collection 
//  Created on: 03-Jan-2005 
//  Object design: John  
//  Coded:   03-Jan-2005 
///////////////////////////////////////////////////////////

using System;
using System.Data;
using GZTW.Data;
using CSLA.Data;
using CSLA;
using System.Collections.Generic;

namespace GZTW.AyaNova.BLL
{
#pragma warning disable 1591
    /// <summary>
    /// Read only list of <see cref="WorkorderQuoteList.WorkorderQuoteListInfo"/> objects representing quotes and used in grids and summary reports
    /// </summary>
    [Serializable]
    public class WorkorderQuoteList : ReadOnlyCollectionBase
    {


        #region Data structure
        /// <summary>
        /// Properties
        /// </summary>
        [Serializable]
        public struct WorkorderQuoteListInfo
        {
            internal GridNameValueCellItem mQuoteWorkorder;
            internal GridNameValueCellItem mClient;
            internal GridNameValueCellItem mProject;
            internal GridNameValueCellItem mRegion;
            internal GridNameValueCellItem mCategory;
            internal string mInternalReferenceNumber;
            internal string mCustomerReferenceNumber;
            internal string mCustomerContactName;
            internal string mSummary;
            internal bool mOnsite;
            internal WorkorderQuoteStatusTypes mQuoteStatusType;
            internal GridNameValueCellItem mPreparedBy;
            internal SmartDate mQuoteRequestDate;
            internal SmartDate mValidUntilDate;
            internal SmartDate mDateSubmitted;
            internal SmartDate mDateApproved;

            //----------------------case 636---------------------------------
            internal GridNameValueCellItem mClientGroup;
            internal GridNameValueCellItem mDispatchZone;
            internal GridNameValueCellItem mHeadOffice;
            [SqlColumnNameAttribute("aClientGroup.aName", "aClientGroup.aID"),
       Display(DisplayType.Button, RootObjectType = RootObjectTypes.ClientGroup)]
            public GridNameValueCellItem LT_O_ClientGroup { get { return mClientGroup; } }

            [SqlColumnNameAttribute("aDispatchZone.aName", "aDispatchZone.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.DispatchZone)]
            public GridNameValueCellItem LT_O_DispatchZone { get { return mDispatchZone; } }

            [SqlColumnNameAttribute("aHeadOffice.aName", "aClient.aHeadOfficeID"),
         Display(DisplayType.Button, RootObjectType = RootObjectTypes.HeadOffice)]
            public GridNameValueCellItem LT_O_HeadOffice { get { return mHeadOffice; } }
            //---------------case 636---------------------------------



            //====================================================================================
            [SqlColumnNameAttribute("aWorkorderQuote.aQuoteNumber", "aWorkorder.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.WorkorderQuote, CompareAs=CompareType.StringToInt32)]
            public GridNameValueCellItem LT_O_WorkorderQuote { get { return mQuoteWorkorder; } }

            [SqlColumnNameAttribute("aClient.aName","aClient.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.Client)]
            public GridNameValueCellItem LT_O_Client { get { return mClient; } }

            [SqlColumnNameAttribute("aProject.aName", "aProject.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.Project)]
            public GridNameValueCellItem LT_O_Project { get { return mProject; } }

            [SqlColumnNameAttribute("aRegion.aName","aRegion.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.Region)]
            public GridNameValueCellItem LT_O_Region { get { return mRegion; } }

            [SqlColumnNameAttribute("aWorkorderCategory.aName","aWorkorderCategory.aID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.WorkorderCategory)]
            public GridNameValueCellItem LT_O_WorkorderCategory { get { return mCategory; } }

            [Display(DisplayType.Text)]
            public string LT_Workorder_Label_InternalReferenceNumber { get { return mInternalReferenceNumber; } }

            [Display(DisplayType.Text)]
            public string LT_Workorder_Label_CustomerReferenceNumber { get { return mCustomerReferenceNumber; } }

            [Display(DisplayType.Text)]
            public string LT_Workorder_Label_CustomerContactName { get { return mCustomerContactName; } }

            [Display(DisplayType.Text)]
            public string LT_Workorder_Label_Summary { get { return mSummary; } }

            [Display(DisplayType.TrueFalse)]
            public bool LT_Workorder_Label_Onsite { get { return mOnsite; } }

            //Case 353
            [Display(DisplayType.ListQuoteStatusTypes)]
            public WorkorderQuoteStatusTypes LT_WorkorderQuote_Label_QuoteStatusType { get { return mQuoteStatusType; } }

           //Changed: 06-July-2006 - was not sorting properly by lastname so changed to 
            //or filtering properly so changed to name value cell item
            [SqlColumnNameAttribute("aUser.aLastName", "aWorkorderQuote.aPreparedByID"),
           Display(DisplayType.Button, RootObjectType = RootObjectTypes.User)]
            public GridNameValueCellItem LT_WorkorderQuote_Label_PreparedByID { get { return this.mPreparedBy; } }

            [Display(DisplayType.DateTime)]
            public object LT_WorkorderQuote_Label_QuoteRequestDate { get { return mQuoteRequestDate.DBValue; } }

            [Display(DisplayType.DateTime)]
            public object LT_WorkorderQuote_Label_ValidUntilDate { get { return mValidUntilDate.DBValue; } }

            [Display(DisplayType.DateTime)]
            public object LT_WorkorderQuote_Label_DateSubmitted { get { return mDateSubmitted.DBValue; } }

            [Display(DisplayType.DateTime)]
            public object LT_WorkorderQuote_Label_DateApproved { get { return mDateApproved.DBValue; } }





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

        }//end WorkorderQuoteListInfo
        #endregion

        #region Constructor

        protected WorkorderQuoteList()
        {
            //			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 WorkorderQuoteListInfo this[int Item]
        {

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


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

            get
            {
                foreach (WorkorderQuoteListInfo child in List)
                {
                    if (child.mQuoteWorkorder.Value == ItemID) return child.ToString();
                }
                return "Missing: " + ItemID.ToString();
            }
        }
        #endregion

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

        }
        #endregion

        #region Reporting and shared UI editor helpers

        /// <summary>
        /// Returns the report key which is a property of
        /// reports used to link all reports that can be used
        /// with a particular data source.
        /// </summary>
        public static string ReportKey
        {
            get
            {
                return "WorkorderQuoteList";
            }
        }


        /// <summary>
        /// Returns the Detailed report key 
        /// which is used to determine which reports and objects
        /// will be used for detailed reports
        /// 
        /// If empty string then indicates there is no detailed report object or reports
        /// </summary>
        public static string DetailedReportKey
        {
            get
            {
                return WorkorderQuoteDetailedReportData.ReportKey;
            }
        }

        /// <summary>
        /// Base object that this list is reporting on
        /// used by shared UI editor to instantiate new objects
        /// when user selects new in UI elements that display this list
        /// 
        /// (I.E. when user clicks on new in a read only list grid, this is the object type created)
        /// </summary>
        public static RootObjectTypes BaseObjectType
        {
            get
            {
                return RootObjectTypes.WorkorderQuote;
            }
        }

        /// <summary>
        /// The Type of the struct used to store list records
        /// Used to fetch the custom display attributes of the fields
        /// contained within the record to modify the grid display accordingly
        /// <see cref="DisplayAttribute"/>
        /// </summary>
        public static Type ListRecordType
        {
            get
            {
                return typeof(WorkorderQuoteListInfo);
            }
        }

        /// <summary>
        /// Locale key so that generic list editor
        /// UI code knows what title to give the list in a
        /// grid
        /// </summary>
        public string LocaleKey
        {
            get
            {
                return "WorkorderQuote.Label.List";
            }
        }

        /// <summary>
        /// Field that contains the ID of the objects
        /// that are the basis of this list.
        /// 
        /// Used for compiling an ID list for reporting from user
        /// selections in a grid.
        /// </summary>
        public static string IDField
        {
            get
            {
                return "LT_O_WorkorderQuote";
            }
        }
        /// <summary>
        /// Same as IDField but for detailed reports
        /// </summary>
        public static string IDFieldDetailed
        {
            get
            {
                return IDField;
            }
        }
        #endregion

        #region Static methods
        /// <summary>
        /// Internal method used by list factory
        /// </summary>
        internal static WorkorderQuoteList Get(string Filter, int MaxRecords, List<Guid> IDList)
        {
            return (WorkorderQuoteList)DataPortal.Fetch(new Criteria(Filter, IDList, MaxRecords));
        }


        /// <summary>
        /// Get all WorkorderQuote (filtered by crit)
        /// </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="WorkorderQuoteList.WorkorderQuoteListInfo"/> objects</returns>

        public static WorkorderQuoteList GetList(string xmlCriteria)
        {
            return (WorkorderQuoteList)DataPortal.Fetch(new Criteria(xmlCriteria, null, -1));
        }


        //added for case 1975 RI
        /// <summary>
        /// Get MaxRecord Quotes filtered by criteria
        /// </summary>
        /// <param name="xmlCriteria"></param>
        /// <param name="MaxRecords"></param>
        /// <returns></returns>
        public static WorkorderQuoteList GetList(string xmlCriteria, int MaxRecords)
        {
            return (WorkorderQuoteList)DataPortal.Fetch(new Criteria(xmlCriteria, null, MaxRecords));
        }


        /// <summary>
        /// Takes a single ID and returns a "list" of one object
        /// </summary>
        /// <param name="WorkorderID">ID of Workorder object</param>
        /// <returns>list of <see cref="WorkorderQuoteList.WorkorderQuoteListInfo"/> objects</returns>
        public static WorkorderQuoteList GetListForSingleItem(Guid WorkorderID)
        {
            //Case 556
            List<Guid> l = new List<Guid>();
            l.Add(WorkorderID);
            return GetListFromIDList(l);
        }

        /// <summary>
        /// Get list by items indicated in IDList
        /// </summary>
        /// <param name="IDList">Generic list of Guid's</param>
        /// <returns>list of <see cref="WorkorderQuoteList.WorkorderQuoteListInfo"/> objects</returns>
        public static WorkorderQuoteList GetListFromIDList(List<Guid> IDList)
        {
            //case 556
            //Handle empty list
            if (IDList.Count == 0)
                return new WorkorderQuoteList();
            return (WorkorderQuoteList)DataPortal.Fetch(new Criteria("", IDList, -1));
        }

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


        #endregion

        #region DAL DATA ACCESS
        /// 
        /// <param name="Criteria"></param>
        protected override void DataPortal_Fetch(object Criteria)
        {

            Criteria crit = (Criteria)Criteria;

            SafeDataReader dr = null;
            try
            {
                DBCommandWrapper cm = null;
                //Base query
                string q = "SELECT ~MAXRECS~ aWorkorder.aID AS aWorkorderID, aWorkorderQuote.aQuoteNumber, " +
                    " aClient.aName AS aClientName, " +
                    " aClient.aID AS ACLIENTID, aWorkorder.aInternalReferenceNumber, " +
                    " aWorkorder.aCustomerReferenceNumber, " +
                    " aProject.aName AS aProjectName, " +
                    " aProject.aID AS aProjectID, aRegion.aName " +
                    "AS aRegionName, aRegion.aID AS aRegionID, " +
                    " aWorkorder.aCustomerContactName, aWorkorder.aSummary, " +
                    " aWorkorderCategory.aName AS aWorkorderCategoryName, " +
                    " aWorkorderCategory.aID AS " +
                    "aWorkorderCategoryID, aWorkorderQuote.aQuoteStatusType, " +
                    " aWorkorderQuote.aPreparedByID, aWorkorderQuote.aQuoteRequestDate, " +
                    " aWorkorderQuote.aValidUntilDate, " +
                    " aWorkorderQuote.aDateSubmitted, " +
                    " aWorkorderQuote.aDateApproved, aWorkorder.aOnsite, " +
                    " aUser.aFirstName, aUser.aLastName, " +
                    " aUser.aInitials, aUser.aEmployeeNumber, " +

                    " aClient.aHeadOfficeID, aHeadOffice.aName as aHeadOfficeName, " + //case 636
                    " aClient.aDispatchZoneID, aDispatchZone.aName AS aDispatchZoneName, " +//case 636
                    " aClient.aClientGroupID, aClientGroup.aName AS aClientGroupName " +//case 636
                
                   

                    "FROM " +
                    " ACLIENT  " +

                    " LEFT OUTER JOIN ADISPATCHZONE ON (ACLIENT.ADISPATCHZONEID=ADISPATCHZONE.AID) " +//case 636
                    " LEFT OUTER JOIN ACLIENTGROUP ON (ACLIENT.ACLIENTGROUPID=ACLIENTGROUP.AID) " +//case 636
                    " LEFT OUTER JOIN AHEADOFFICE ON (ACLIENT.AHEADOFFICEID=AHEADOFFICE.AID) " +//case 636

                    " INNER JOIN AWORKORDER ON (ACLIENT.AID=AWORKORDER.ACLIENTID) " +
                    " LEFT OUTER JOIN AREGION ON (ACLIENT.AREGIONID=AREGION.AID) " +
                    " LEFT OUTER JOIN AWORKORDERCATEGORY ON (AWORKORDER.AWORKORDERCATEGORYID=AWORKORDERCATEGORY.AID) " +
                    " INNER JOIN AWORKORDERQUOTE ON (AWORKORDERQUOTE.AWORKORDERID=AWORKORDER.AID) " +
                    " LEFT OUTER JOIN aUser ON (aWorkorderQuote.aPreparedByID = aUser.aID) " +
                    " LEFT OUTER JOIN APROJECT ON (APROJECT.AID=AWORKORDER.APROJECTID) " +

                    "WHERE (aWorkorder.aWorkorderType " +
                    "= 3) ";

                if (crit.MaxRecords > 0)
                    q = q.Replace("~MAXRECS~", "TOP " + crit.MaxRecords.ToString());
                else
                    q = q.Replace("~MAXRECS~", "");

             

                //One item or grid criteria?
                if (crit.IDList != null)
                {
                    //Case 556
                    System.Text.StringBuilder sbIN = new System.Text.StringBuilder();
                    sbIN.Append(" AND (aWorkorder.aID in (");
                    foreach (Guid gItem in crit.IDList)
                    {
                        sbIN.Append("'");
                        sbIN.Append("{");
                        sbIN.Append(gItem.ToString().ToUpperInvariant());
                        sbIN.Append("}");
                        sbIN.Append("',");
                    }
                    sbIN.Length = sbIN.Length - 1;
                    sbIN.Append(")) ");

                    //One item:
                    cm = DBUtil.DB.GetSqlStringCommandWrapper(q + sbIN.ToString() + " " +
                        AyaBizUtils.GetGridSortOrderColumns(crit.CriteriaXML));
                    
                }
                else
                {
                    //Grid criteria
                    cm = DBUtil.DB.GetSqlStringCommandWrapper(DBUtil.AddRegionFilter(//case 58
                        q +
                        AyaBizUtils.GetGridColumnCriteria(crit.CriteriaXML, false) + " " +
                        AyaBizUtils.GetGridSortOrderColumns(crit.CriteriaXML)
                        )
                        );
                }



                dr = new SafeDataReader(DBUtil.DB.ExecuteReader(cm));


                while (dr.Read())
                {
                    //*******************************************
                    WorkorderQuoteListInfo info = new WorkorderQuoteListInfo();

                    info.mQuoteWorkorder = new GridNameValueCellItem(
                        dr.GetGuid("aWorkorderID"),
                        dr.GetInt32("aQuoteNumber").ToString(),
                        RootObjectTypes.Workorder);

                    info.mClient = new GridNameValueCellItem(
                        dr.GetGuid("aClientID"),
                        dr.GetString("aClientName"),
                        RootObjectTypes.Client);

                    info.mProject = new GridNameValueCellItem(
                        dr.GetGuid("aProjectID"),
                        dr.GetString("aProjectName"),
                        RootObjectTypes.Project);

                    info.mRegion = new GridNameValueCellItem(
                        dr.GetGuid("aRegionID"),
                        dr.GetString("aRegionName"),
                        RootObjectTypes.Region);

                    info.mQuoteStatusType = (WorkorderQuoteStatusTypes)dr.GetInt16("aQuoteStatusType");

                    info.mCategory = new GridNameValueCellItem(
                        dr.GetGuid("aWorkorderCategoryID"),
                        dr.GetString("aWorkorderCategoryName"),
                        RootObjectTypes.WorkorderCategory);

                    info.mInternalReferenceNumber = dr.GetString("aInternalReferenceNumber");
                    info.mCustomerReferenceNumber = dr.GetString("aCustomerReferenceNumber");
                    info.mCustomerContactName = dr.GetString("aCustomerContactName");
                    info.mSummary = dr.GetString("aSummary");
                    info.mOnsite = dr.GetBoolean("aOnsite");

                    info.mPreparedBy = new GridNameValueCellItem(
                       dr.GetGuid("aPreparedByID"),
                       User.NameFormatter(dr.GetString("aFirstName"), dr.GetString("aLastName"),
                   dr.GetString("aInitials"), dr.GetString("aEmployeeNumber"), dr.GetString("AREGIONNAME"),
                   AyaBizUtils.GlobalSettings.DefaultScheduleableUserNameDisplayFormat),
                       RootObjectTypes.User);
                   
                    info.mQuoteRequestDate = DBUtil.ToLocal(dr.GetSmartDate("aQuoteRequestDate"));
                    info.mValidUntilDate = DBUtil.ToLocal(dr.GetSmartDate("aValidUntilDate"));
                    info.mDateSubmitted = DBUtil.ToLocal(dr.GetSmartDate("aDateSubmitted"));
                    info.mDateApproved = DBUtil.ToLocal(dr.GetSmartDate("aDateApproved"));

                    //-------case 636-----------------------------
                    info.mHeadOffice = new GridNameValueCellItem(
                      dr.GetGuid("aHeadOfficeID"),
                      dr.GetString("aHeadOfficeName"),
                      RootObjectTypes.HeadOffice);

                    info.mDispatchZone = new GridNameValueCellItem(
                      dr.GetGuid("aDispatchZoneID"),
                      dr.GetString("aDispatchZoneName"),
                      RootObjectTypes.DispatchZone);

                    info.mClientGroup = new GridNameValueCellItem(
                        dr.GetGuid("aClientGroupID"),
                        dr.GetString("aClientGroupName"),
                        RootObjectTypes.ClientGroup);
                    //-------case 636-----------------------------

                    InnerList.Add(info);
                    //*******************************************
                }
            }
            finally
            {
                if (dr != null) dr.Close();
            }

        }
        #endregion

        #region criteria
        /// <summary>
        /// Criteria for identifying existing object
        /// </summary>
        [Serializable]
        private class Criteria
        {
            public List<Guid> IDList;
            public string CriteriaXML;
            public int MaxRecords;
            public Criteria(string _CriteriaXML, List<Guid> _IDList, int _MaxRecords)
            {
                CriteriaXML = _CriteriaXML;
                IDList = _IDList;
                MaxRecords = _MaxRecords;
            }
        }
        #endregion


    }//end WorkorderQuoteList
#pragma warning restore 1591
}//end namespace GZTW.AyaNova.BLL