#region << 版 本 注 释 >>
/*----------------------------------------------------------------
 * 命名空间：WIDESEAWCS_QuartzJob
 * 创建者：胡童庆
 * 创建时间：2024/8/2 16:13:36
 * 版本：V1.0.0
 * 描述：调度服务接口层
 *
 * ----------------------------------------------------------------
 * 修改人：
 * 修改时间：
 * 版本：V1.0.1
 * 修改说明：
 * 
 *----------------------------------------------------------------*/
#endregion << 版 本 注 释 >>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WIDESEAWCS_Core;
using WIDESEAWCS_QuartzJob.DTO;

namespace WIDESEAWCS_QuartzJob
{
    /// <summary>
    /// 调度中心接口，提供任务调度的基本操作
    /// </summary>
    /// <remarks>
    /// 该接口定义了任务调度的核心功能，包括启动/停止调度、添加/停止任务、
    /// 检查任务存在性、暂停/恢复任务、立即执行任务以及获取触发器状态等。
    /// 所有方法均返回包含操作结果的WebResponseContent对象或布尔值。
    /// </remarks>
    public interface ISchedulerCenter
    {

        /// <summary>
        /// 开启任务调度
        /// </summary>
        /// <returns></returns>
        Task<WebResponseContent> StartScheduleAsync();

        /// <summary>
        /// 停止任务调度
        /// </summary>
        /// <returns></returns>
        Task<WebResponseContent> StopScheduleAsync();
        /// <summary>
        /// 
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        Task<WebResponseContent> AddScheduleJobAsync(DispatchInfoDTO sysSchedule);

        /// <summary>
        /// 停止一个任务
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        Task<WebResponseContent> StopScheduleJobAsync(DispatchInfoDTO sysSchedule);

        /// <summary>
        /// 检测任务是否存在
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        Task<bool> IsExistScheduleJobAsync(DispatchInfoDTO sysSchedule);

        /// <summary>
        /// 暂停指定的计划任务
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        Task<WebResponseContent> PauseJob(DispatchInfoDTO sysSchedule);

        /// <summary>
        /// 恢复一个任务
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        Task<WebResponseContent> ResumeJob(DispatchInfoDTO sysSchedule);

        //Task<WebResponseContent> PauseAllJobAsync();

        //Task<WebResponseContent> ResumeAllJobAsync();

        /// <summary>
        /// 获取任务触发器状态
        /// </summary>
        /// <param name="sysSchedule"></param>
        /// <returns></returns>
        //Task<List<DispatchInfoDTO>> GetTaskStaus(DispatchInfoDTO sysSchedule);

        /// <summary>
        /// 获取触发器标识
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        string GetTriggerState(string key);

        /// <summary>
        /// 立即执行 一个任务
        /// </summary>
        /// <param name="tasksQz"></param>
        /// <returns></returns>
        Task<WebResponseContent> ExecuteJobAsync(DispatchInfoDTO tasksQz);

    }
}