using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DPumpHydr.OpenModel
{
    /// <summary>
    /// 执行返回的通用类，该类不带业务数据，只会告诉用户此次调用是否成功与否，以及一个表示提示信息的字符串
    /// </summary>
    public class ApiResult
    {
        /// <summary>
        /// 状态信息
        /// </summary>
        public ApiResultCode Code { get; set; }

        /// <summary>
        /// 提示信息
        /// </summary>
        public string Message { get; set; }


        /// <summary>
        ///设计参数
        /// </summary>
        public DesignParameter DesignParameter { get; set; }


        /// <summary>
        /// 构造函数
        /// </summary>
        public ApiResult()
        {
            this.Code = ApiResultCode.Success;
        }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="type">结果状态标识</param>
        /// <param name="message">提示信息</param>
        public ApiResult(ApiResultCode type, string message)
        {
            this.Code = type;
            this.Message = message;
        }

        /// <summary>
        /// 构造函数，默认返回状态Error
        /// </summary>
        /// <param name="message">提示信息</param>
        public ApiResult(string message)
        {
            this.Code = ApiResultCode.Error;
            this.Message = message;
        }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="type">状态标识</param>
        public ApiResult(ApiResultCode type) : this(type, "") { }

        /// <summary>
        /// 返回一个表示通用的出错对象
        /// </summary>
        /// <param name="message">提示信息</param>
        /// <returns>通用的出错对象</returns>
        public static ApiResult Error(string message)
        {
            return new ApiResult(ApiResultCode.Error, message);
        }

        /// <summary>
        /// 返回一个表示通用的成功对象
        /// </summary>
        /// <param name="message">提示信息</param>
        /// <returns>通用的成功对象</returns>
        public static ApiResult Success(string message = "")
        {
            return new ApiResult(ApiResultCode.Success, message);
        }
    }


}