C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Libraries/Mcs.Epm.MicrosoftProject.mpFx/ProjectCustomField.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.Generic;
using System.Diagnostics;
using Mcs.Epm.MicrosoftProject.mpFx.ProjectsWebService;

namespace Mcs.Epm.MicrosoftProject.mpFx
{
    /// <summary>
    /// Wraps a custom field for a specific enterprise project
    /// </summary>
    public class ProjectCustomField
    {
        #region Instance data

        private readonly ProjectCustomFieldsCollection _Parent;
        private object _Value;

        #endregion

        #region Constructor

        /// <summary>
        /// Create a project custom field
        /// </summary>
        /// <param name="parent">ResourceCustomFieldsCollection Parent Container</param>
        /// <param name="propertyGuid">Resource Custom Field MD_PROP_UID</param>
        /// <param name="name"></param>
        internal ProjectCustomField(ProjectCustomFieldsCollection parent,
                                    Guid propertyGuid,
                                    string name)
        {
            if (parent == null)
            {
                throw new ArgumentNullException( /*  TODO: Exception Message */);
            }

            _Parent = parent;
            Name = name;
            PropertyGuid = propertyGuid;
        }

        #endregion

        #region Public Properties

        /// <summary>
        /// Returns true if value is a list, false if it is a single value
        /// </summary>
        public bool IsList
        {
            get { return _Value as List<object> != null; }
        }

        /// <summary>
        /// If IsList = true, the values for the resource custom fields values are accessible through this property
        /// </summary>
        public List<object> List
        {
            get
            {
                if (IsList)
                {
                    return _Value as List<object>;
                }
                return null;
            }
        }

        /// <summary>
        /// Get the type of data contained in List or Value
        /// </summary>
        public CustomFieldValueType Type { get; private set; }

        /// <summary>
        /// Get the property GUID for this resource custom field
        /// </summary>
        public Guid PropertyGuid { get; private set; }

        /// <summary>
        /// Get the name of the custom field
        /// </summary>
        public string Name { get; private set; }

        /// <summary>
        /// Get the resource custom field value (if IsList = false)
        /// </summary>
        public object Value
        {
            get
            {
                if (_Value == null)
                {
                    LoadProjectCustomFieldValue();
                }

                return _Value;
            }
        }

        #endregion

        #region Private Methods

        /// <summary>
        /// Load the value of resource custom field
        /// </summary>
        private void LoadProjectCustomFieldValue()
        {
            var values = new List<object>();

            CustomFieldValueType type = CustomFieldValueType.None;

            foreach (ProjectDataSet.ProjectCustomFieldsRow customField in _Parent.Parent.CustomFieldsDataSet.Rows)
            {
                if (customField.MD_PROP_UID == PropertyGuid)
                {
                    object value;

                    if (ProjectCustomFieldsCollection.TryGetFieldValueInformation(_Parent.Parent.Parent.Parent,
                                                                                  _Parent.Parent.Parent.
                                                                                      CustomFieldsDataSet.CustomFields.
                                                                                      FindByMD_PROP_UID(PropertyGuid),
                                                                                  customField,
                                                                                  true,
                                                                                  out value,
                                                                                  out type))
                    {
                        values.Add(value);
                    }
                }
            }

            if (values.Count > 1)
            {
                _Value = values;
            }
            else
            {
                if (values.Count == 1)
                {
                    _Value = values[0];

                    Type = type;
                }
                else
                {
                    Debug.Assert(values.Count == 0);

                    _Value = null;

                    Type = CustomFieldValueType.None;
                }
            }
        }

        #endregion

        public void Update(string newValue, bool checkOut)
        {
            Guid sessionGuid = Guid.NewGuid();
            Guid projectGuid = _Parent.Parent.ProjectGuid;

            if (checkOut)
            {
                _Parent.Parent.Parent.Parent.WebServices.Projects.CheckOutProject(projectGuid, sessionGuid, newValue);    
            }
            
            using (ProjectDataSet customFieldDataSet =_Parent.Parent.Parent.Parent.WebServices.Projects.ReadProjectEntities(_Parent.Parent.ProjectGuid,
                                                                                          (int)(ProjectEntityType.ProjectCustomFields | ProjectEntityType.Project),
                                                                                          _Parent.Parent.Parent.Parent.Store))
            {
                if (customFieldDataSet != null)
                {
                    foreach (ProjectDataSet.ProjectCustomFieldsRow customField in customFieldDataSet.ProjectCustomFields.Rows)
                    {
                        if (customField.MD_PROP_UID == PropertyGuid)
                        {
                            customField.TEXT_VALUE = newValue;
                            break;
                        }
                    }

                    sessionGuid = customFieldDataSet.Project[0].PROJ_SESSION_UID;

                    _Parent.Parent.Parent.Parent.WebServices.Projects.QueueUpdateProject(Guid.NewGuid(),
                                                                                         sessionGuid,
                                                                                         customFieldDataSet,
                                                                                         false);                    
                }
            }

            if (checkOut)
            {
                string errorMessage;

                _Parent.Parent.Parent.CheckIn(projectGuid, sessionGuid, false, true, out errorMessage);                
            }
        }
    }
}

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

---