C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Libraries/Mcs.Epm.MicrosoftProject.mpFx/ProjectCustomFieldsCollection.cs

/*  ----------------------------------------------------------------------------
 *  Microsoft Corporation
 *  ----------------------------------------------------------------------------
 *  Microsoft Project Server mpFx (mpFx)
 *  ----------------------------------------------------------------------------
 *  Author: Colby Africa
 *  ----------------------------------------------------------------------------
 *  License: http://code.msdn.microsoft.com/mpFx/Project/License.aspx
 *  ----------------------------------------------------------------------------
 */

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using Mcs.Epm.MicrosoftProject.mpFx.CustomFieldsWebService;
using Mcs.Epm.MicrosoftProject.mpFx.ProjectsWebService;
using Microsoft.Office.Project.Server.Library;

namespace Mcs.Epm.MicrosoftProject.mpFx
{
    /// <summary>
    /// A collection class for ProjectCCustomFields
    /// </summary>
    public class ProjectCustomFieldsCollection : ICollection<ProjectCustomField>
    {
        #region Static Methods

        /// <summary>
        /// Given a custom field definition and a resource custom field, attempt to get the value and type
        /// </summary>
        /// <param name="projectServer">ProjectServer object</param>
        /// <param name="customFieldDefinition">Custom field definition</param>
        /// <param name="customField">Resource custom field</param>
        /// <param name="value">Out value containing the custom field value if successfull</param>
        /// <param name="type">Out value containong the data type if successfull</param>
        /// <returns>True for success, false if not</returns>
        public static bool TryGetFieldValueInformation(ProjectServer projectServer,
                                                       CustomFieldDataSet.CustomFieldsRow customFieldDefinition,
                                                       ProjectDataSet.ProjectCustomFieldsRow customField,
                                                       bool multiLang,
                                                       out object value,
                                                       out CustomFieldValueType type)
        {
            PSDataType dataType = (PSDataType) customField.FIELD_TYPE_ENUM;

            type = CustomFieldValueType.None;
            value = null;

            switch (dataType)
            {
                case PSDataType.STRING:

                    if (customField.IsTEXT_VALUENull() == false)
                    {
                        value = customField.TEXT_VALUE;
                        type = CustomFieldValueType.Text;
                    }
                    else if (customField.IsCODE_VALUENull() == false)
                    {
                        if (multiLang)
                        {
                            value = projectServer.LookupTables.MultiLangGetLookupTableTextValue(customFieldDefinition.MD_LOOKUP_TABLE_UID,
                                                                                                 customField.CODE_VALUE,
                                                                                                 1033);                            
                        }

                        type = CustomFieldValueType.Text;
                    }
                    break;

                case PSDataType.NUMBER:

                    value = customField.NUM_VALUE.ToString();
                    type = CustomFieldValueType.Number;
                    break;

                case PSDataType.DATE:

                    value = customField.DATE_VALUE.ToUniversalTime().ToLongDateString();
                    type = CustomFieldValueType.Date;
                    break;

                default:
                    break;
            }

            return type != CustomFieldValueType.None;
        }

        #endregion

        #region Instance Data

        private Collection<ProjectCustomField> _ProjectCustomFieldsCollection;
        private readonly bool _IsReadOnly;

        #endregion

        #region Constructor

        /// <summary>
        /// Create an instance of ResourceCustomFieldsCollection
        /// </summary>
        /// <param name="parent">EnterpriseResource Parent Object</param>
        internal ProjectCustomFieldsCollection(EnterpriseProject parent)
        {
            //  Class cannot be created externally

            if (parent == null)
            {
                throw new ArgumentNullException( /*  TODO: Exception Message */);
            }

            Parent = parent;

            _IsReadOnly = true;

            LoadProjectCustomFieldsCollection();
        }

        #endregion;

        #region Internal Properties

        /// <summary>
        /// Retrieve parent object
        /// </summary>
        internal EnterpriseProject Parent { get; private set; }

        #endregion

        #region Indexer

        /// <summary>
        /// For a given field GUID, retrieve the ResourceCustomField
        /// </summary>
        /// <param name="fieldGuid">GUID of field to retrieve</param>
        /// <returns></returns>
        public ProjectCustomField this[Guid fieldGuid]
        {
            get
            {
                foreach (ProjectCustomField customField in _ProjectCustomFieldsCollection)
                {
                    if (customField.PropertyGuid == fieldGuid)
                    {
                        return customField;
                    }
                }

                return null;
            }
        }

        #endregion

        #region Private Methods

        /// <summary>
        /// Load custom fields defined for resources
        /// </summary>
        private void LoadProjectCustomFieldsCollection()
        {
            if (_ProjectCustomFieldsCollection == null)
            {
                _ProjectCustomFieldsCollection = new Collection<ProjectCustomField>();
            }
            else
            {
                _ProjectCustomFieldsCollection.Clear();
            }

            List<Guid> loadedFields = new List<Guid>();

            foreach (ProjectDataSet.ProjectCustomFieldsRow customField in Parent.CustomFieldsDataSet.Rows)
            {
                if (!loadedFields.Contains(customField.MD_PROP_UID))
                {
                    ProjectCustomField field = new ProjectCustomField(this,
                                                                      customField.MD_PROP_UID,
                                                                      Parent.Parent.CustomFieldsDataSet.CustomFields.FindByMD_PROP_UID(customField.MD_PROP_UID).MD_PROP_NAME);

                    _ProjectCustomFieldsCollection.Add(field);

                    loadedFields.Add(customField.MD_PROP_UID);
                }
            }
        }

        #endregion

        public bool ContainsKey(Guid key)
        {
            foreach (ProjectCustomField field in _ProjectCustomFieldsCollection)
            {
                if (field.PropertyGuid == key)
                {
                    return true;
                }
            }
            return false;
        }

        #region ICollection<ProjectCustomField> Members

        ///<summary>
        ///Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</summary>
        ///
        ///<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"></see>.</param>
        ///<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"></see> is read-only.</exception>
        void ICollection<ProjectCustomField>.Add(ProjectCustomField item)
        {
            _ProjectCustomFieldsCollection.Add(item);
        }

        ///<summary>
        ///Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</summary>
        ///
        ///<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"></see> is read-only. </exception>
        void ICollection<ProjectCustomField>.Clear()
        {
            _ProjectCustomFieldsCollection.Clear();
        }

        ///<summary>
        ///Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"></see> contains a specific value.
        ///</summary>
        ///
        ///<returns>
        ///true if item is found in the <see cref="T:System.Collections.Generic.ICollection`1"></see>; otherwise, false.
        ///</returns>
        ///
        ///<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"></see>.</param>
        bool ICollection<ProjectCustomField>.Contains(ProjectCustomField item)
        {
            return _ProjectCustomFieldsCollection.Contains(item);
        }

        ///<summary>
        ///Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1"></see> to an <see cref="T:System.Array"></see>, starting at a particular <see cref="T:System.Array"></see> index.
        ///</summary>
        ///
        ///<param name="array">The one-dimensional <see cref="T:System.Array"></see> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1"></see>. The <see cref="T:System.Array"></see> must have zero-based indexing.</param>
        ///<param name="arrayIndex">The zero-based index in array at which copying begins.</param>
        ///<exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0.</exception>
        ///<exception cref="T:System.ArgumentNullException">array is null.</exception>
        ///<exception cref="T:System.ArgumentException">array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1"></see> is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.</exception>
        void ICollection<ProjectCustomField>.CopyTo(ProjectCustomField[] array,
                                                    int arrayIndex)
        {
            _ProjectCustomFieldsCollection.CopyTo(array, arrayIndex);
        }

        ///<summary>
        ///Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</summary>
        ///
        ///<returns>
        ///true if item was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"></see>; otherwise, false. This method also returns false if item is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</returns>
        ///
        ///<param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"></see>.</param>
        ///<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"></see> is read-only.</exception>
        bool ICollection<ProjectCustomField>.Remove(ProjectCustomField item)
        {
            return _ProjectCustomFieldsCollection.Remove(item);
        }

        ///<summary>
        ///Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</summary>
        ///
        ///<returns>
        ///The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"></see>.
        ///</returns>
        ///
        int ICollection<ProjectCustomField>.Count
        {
            get { return _ProjectCustomFieldsCollection.Count; }
        }

        ///<summary>
        ///Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"></see> is read-only.
        ///</summary>
        ///
        ///<returns>
        ///true if the <see cref="T:System.Collections.Generic.ICollection`1"></see> is read-only; otherwise, false.
        ///</returns>
        ///
        bool ICollection<ProjectCustomField>.IsReadOnly
        {
            get { return _IsReadOnly; }
        }

        ///<summary>
        ///Returns an enumerator that iterates through the collection.
        ///</summary>
        ///
        ///<returns>
        ///A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection.
        ///</returns>
        ///<filterpriority>1</filterpriority>
        IEnumerator<ProjectCustomField> IEnumerable<ProjectCustomField>.GetEnumerator()
        {
            return _ProjectCustomFieldsCollection.GetEnumerator();
        }

        ///<summary>
        ///Returns an enumerator that iterates through a collection.
        ///</summary>
        ///
        ///<returns>
        ///An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
        ///</returns>
        ///<filterpriority>2</filterpriority>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return ((IEnumerable<ResourceCustomField>) this).GetEnumerator();
        }

        #endregion
    }
}

/* ------------------------------------------------------------------------------------------------------- 
 * Change Log
 * -------------------------------------------------------------------------------------------------------
 * 2008-06-06: Colby Africa - Added header and footer
 * 2008-06-06: Colby Africa - Regionized members
*/

---