using DS.Module.Core;
using DS.WMS.Core.Flow.Dtos;

namespace DS.WMS.Core.Flow.Interface;

/// <summary>
/// 工作流
/// </summary>
public interface IFlowInstanceService
{
    /// <summary>
    /// 列表查询
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    DataResult<List<FlowInstanceRes>> GetListByPage(PageRequest request);

    /// <summary>
    /// 添加编辑
    /// </summary>
    /// <param name="req"></param>
    /// <returns></returns>
    DataResult EditFlowInstance(FlowInstanceReq req);

    /// <summary>
    /// 获取详情
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    DataResult<FlowInstanceRes> GetFlowInstanceInfo(string id);

    /// <summary>
    /// 启动实例
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    public DataResult StartFlowInstance(string id);

    /// <summary>
    /// 创建工作流实例
    /// </summary>
    /// <param name="req"></param>
    /// <returns></returns>
    public DataResult CreateFlowInstance(CreateFlowInstanceReq req);

    /// <summary>
    /// 工作流审批
    /// </summary>
    /// <param name="req"></param>
    /// <returns></returns>
    Task<DataResult> AuditAsync(FlowInstanceAuditReq req);

    /// <summary>
    /// 撤销工作流
    /// </summary>
    /// <param name="req"></param>
    /// <returns></returns>
    public DataResult WithdrawFlowInstance(CancelFlowInstanceReq req);

    /// <summary>
    /// 获取流程操作历史
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    DataResult<List<FlowInstanceHistoryRes>> GetFlowInstanceHistoryList(string id);

}