﻿////////////////////////////////////////////////////////////////////////////////
// The MIT License (MIT)
//
// Copyright (c) 2021 Tim Stair
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
////////////////////////////////////////////////////////////////////////////////

using System.Threading;

namespace Support.Progress
{
    public interface ProgressReporterFactory
    {
        /// <summary>
        /// Creates a progress reporter.
        /// </summary>
        /// <param name="sTitle">The title of the process to report</param>
        /// <param name="arrayDescriptions">Descriptions of the sub statuses</param>
        /// <param name="zThreadStart">The thread entry point to execute</param>
        /// <returns>The progress reporter</returns>
        IProgressReporter CreateReporter(string sTitle, string[] arrayDescriptions, ThreadStart zThreadStart);

        /// <summary>
        /// Creates a progress reporter.
        /// </summary>
        /// <param name="sTitle">The title of the process to report</param>
        /// <param name="arrayDescriptions">Descriptions of the sub statuses</param>
        /// <param name="zThreadStart">The thread entry point to execute</param>
        /// <param name="zParamObject">The parameter to pass into the thread for execution</param>
        /// <returns>The progress reporter</returns>
        IProgressReporter CreateReporter(string sTitle, string[] arrayDescriptions, ParameterizedThreadStart zThreadStart, object zParamObject);
    }
}
