C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Libraries/Mcs.Epm.MicrosoftProject.mpFx/Queue.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.Threading;
using Mcs.Epm.MicrosoftProject.mpFx.QueueWebService;
using LibraryResources = Mcs.Epm.MicrosoftProject.mpFx.Properties.Resources;

namespace Mcs.Epm.MicrosoftProject.mpFx
{
    /// <summary>
    /// Provides data and functionality for working with the Project Server queue
    /// </summary>
    public class Queue
    {
        #region Instance Data

        private readonly ProjectServer _Parent;

        #endregion

        #region Constructor

        /// <summary>
        /// Create an instance of Queue
        /// </summary>
        /// <param name="parent">Parent Object</param>
        public Queue(ProjectServer parent)
        {
            if (parent == null)
            {
                throw new ArgumentNullException( /*  TODO: Exception Message  */);
            }
            _Parent = parent;
        }

        #endregion

        #region Public Methods

        /// <summary>
        /// Wait on a given job until its job state matches the provided state or the retry/wait is exceeded
        /// </summary>
        /// <param name="jobGuid">The GUID of the job to wait on</param>
        /// <param name="jobState">The job state to wait for</param>
        /// <param name="count">The number of times to retry</param>
        /// <param name="duration">The wait interval between retries in milliseconds</param>
        /// <param name="errorString">Out parameter containing the error string if the queued job failes</param>
        /// <returns></returns>
        public bool WaitOnJobStatus(Guid jobGuid,
                                    JobState jobState,
                                    int count,
                                    int duration,
                                    out string errorString)
        {
            errorString = string.Empty;

            for (int i = 0; i < count - 1; i++)
            {
                JobState currentState = _Parent.WebServices.Queue.GetJobCompletionState(jobGuid, out errorString);

                if (currentState == jobState)
                {                    
                    return true;
                }

                if (currentState == JobState.Canceled && jobState != JobState.Canceled)
                {
                    throw MpFxException.Create(LibraryResources.ExceptionOperationCanceled);
                }

                if (IsFailureState(jobState))
                {
                    return false;
                }

                Thread.Sleep(duration);
            }

            return false;
        }

        private static bool IsFailureState(JobState jobState)
        {
            return jobState == JobState.Unknown
                   || jobState == JobState.Failed
                   || jobState == JobState.FailedNotBlocking
                   || jobState == JobState.CorrelationBlocked;
        }

        #endregion

        public void CancelJob(Guid jobGuid)
        {
            _Parent.WebServices.Queue.CancelJob(jobGuid, true, true);
        }
    }
}

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

---