补充注释

2026-08-24 15:32:50 +08:00
parent b8b2d7e3fa
commit 22a7df5bec
84 changed files with 5913 additions and 45 deletions
@@ -1,27 +1,73 @@
 namespace SimpleAdmin.Application;

+/// <summary>
+/// 合同适用范围分页查询参数。
+/// </summary>
 public class OnboardingContractScopePageInput : BasePageInput
 {
+    /// <summary>
+    /// 入职业务公司 Id。
+    /// </summary>
    public long? CompanyId { get; set; }
+
+    /// <summary>
+    /// 岗位 Id；为空时表示公司级配置。
+    /// </summary>
    public long? PositionId { get; set; }
+
+    /// <summary>
+    /// 合同模板 Id。
+    /// </summary>
    public long? TemplateId { get; set; }
 }

+/// <summary>
+/// 新增合同适用范围参数。
+/// </summary>
 public class OnboardingContractScopeAddInput
 {
+    /// <summary>
+    /// 入职业务公司 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "公司Id不能为空")]
    public long CompanyId { get; set; }
+
+    /// <summary>
+    /// 岗位 Id；为空时表示公司级配置。
+    /// </summary>
    public long? PositionId { get; set; }
+
+    /// <summary>
+    /// 合同模板 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板Id不能为空")]
    public long TemplateId { get; set; }
+
+    /// <summary>
+    /// 合同模板版本 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板版本Id不能为空")]
    public long TemplateVersionId { get; set; }
+
+    /// <summary>
+    /// 是否必填、必传或必签。
+    /// </summary>
    public bool Required { get; set; } = true;
+
+    /// <summary>
+    /// 显示排序码。
+    /// </summary>
    public int? SortCode { get; set; }
 }

+/// <summary>
+/// 编辑合同适用范围参数。
+/// </summary>
 public class OnboardingContractScopeEditInput : OnboardingContractScopeAddInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "适用范围Id不能为空")]
    public long Id { get; set; }
 }
@@ -1,26 +1,68 @@
 namespace SimpleAdmin.Application;

+/// <summary>
+/// 合同模板分页查询参数。
+/// </summary>
 public class OnboardingContractTemplatePageInput : BasePageInput
 {
+    /// <summary>
+    /// 合同模板名称。
+    /// </summary>
    public string TemplateName { get; set; }
+
+    /// <summary>
+    /// 合同类型。
+    /// </summary>
    public string ContractType { get; set; }
+
+    /// <summary>
+    /// 启用状态或状态筛选条件。
+    /// </summary>
    public string Status { get; set; }
 }

+/// <summary>
+/// 新增合同模板参数。
+/// </summary>
 public class OnboardingContractTemplateAddInput
 {
+    /// <summary>
+    /// 合同模板业务编码。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "模板编码不能为空")]
    public string TemplateCode { get; set; }
+
+    /// <summary>
+    /// 合同模板名称。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "模板名称不能为空")]
    public string TemplateName { get; set; }
+
+    /// <summary>
+    /// 合同类型。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "合同类型不能为空")]
    public string ContractType { get; set; }
+
+    /// <summary>
+    /// 业务说明。
+    /// </summary>
    public string Description { get; set; }
+
+    /// <summary>
+    /// 启用状态或状态筛选条件。
+    /// </summary>
    public string Status { get; set; } = "enable";
 }

+/// <summary>
+/// 编辑合同模板参数。
+/// </summary>
 public class OnboardingContractTemplateEditInput : OnboardingContractTemplateAddInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板Id不能为空")]
    public long Id { get; set; }
 }
@@ -1,30 +1,80 @@
 namespace SimpleAdmin.Application;

+/// <summary>
+/// 合同模板版本分页查询参数。
+/// </summary>
 public class OnboardingContractVersionPageInput : BasePageInput
 {
+    /// <summary>
+    /// 合同模板 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板Id不能为空")]
    public long TemplateId { get; set; }
+
+    /// <summary>
+    /// 模板版本状态。
+    /// </summary>
    public string VersionStatus { get; set; }
 }

+/// <summary>
+/// 新增合同模板版本参数。
+/// </summary>
 public class OnboardingContractVersionAddInput
 {
+    /// <summary>
+    /// 合同模板 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板Id不能为空")]
    public long TemplateId { get; set; }
+
+    /// <summary>
+    /// 模板版本号。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "版本号不能为空")]
    public string VersionNo { get; set; }
+
+    /// <summary>
+    /// 模板 DOCX 源文件 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "DOCX源文件不能为空")]
    public long SourceDocxFileId { get; set; }
+
+    /// <summary>
+    /// 源文件内容哈希。
+    /// </summary>
    public string FileHash { get; set; }
+
+    /// <summary>
+    /// 生效日期。
+    /// </summary>
    public DateTime? EffectiveDate { get; set; }
+
+    /// <summary>
+    /// 失效日期。
+    /// </summary>
    public DateTime? ExpiryDate { get; set; }
+
+    /// <summary>
+    /// 业务备注。
+    /// </summary>
    public string Remark { get; set; }
 }

+/// <summary>
+/// 设置合同模板版本状态参数。
+/// </summary>
 public class OnboardingContractVersionStatusInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "版本Id不能为空")]
    public long Id { get; set; }
+
+    /// <summary>
+    /// 模板版本状态。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "版本状态不能为空")]
    public string VersionStatus { get; set; }
 }
@@ -1,35 +1,101 @@
 namespace SimpleAdmin.Application;

+/// <summary>
+/// 模板变量分页查询参数。
+/// </summary>
 public class OnboardingTemplateVariablePageInput : BasePageInput
 {
+    /// <summary>
+    /// 合同模板版本 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板版本Id不能为空")]
    public long TemplateVersionId { get; set; }
 }

+/// <summary>
+/// 新增模板变量参数。
+/// </summary>
 public class OnboardingTemplateVariableAddInput
 {
+    /// <summary>
+    /// 合同模板版本 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板版本Id不能为空")]
    public long TemplateVersionId { get; set; }
+
+    /// <summary>
+    /// 合同变量编码。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量编码不能为空")]
    public string VariableCode { get; set; }
+
+    /// <summary>
+    /// 合同变量名称。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量名称不能为空")]
    public string VariableName { get; set; }
+
+    /// <summary>
+    /// 合同变量来源类型。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量类型不能为空")]
    public string VariableType { get; set; }
+
+    /// <summary>
+    /// 字段或变量数据类型。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "数据类型不能为空")]
    public string DataType { get; set; }
+
+    /// <summary>
+    /// 关联的候选人基础信息字段。
+    /// </summary>
    public string EmployeeField { get; set; }
+
+    /// <summary>
+    /// 默认值。
+    /// </summary>
    public string DefaultValue { get; set; }
+
+    /// <summary>
+    /// 可选项 JSON。
+    /// </summary>
    public string OptionsJson { get; set; }
+
+    /// <summary>
+    /// 格式化规则。
+    /// </summary>
    public string FormatRule { get; set; }
+
+    /// <summary>
+    /// 是否必填、必传或必签。
+    /// </summary>
    public bool Required { get; set; }
+
+    /// <summary>
+    /// 人事是否可以编辑。
+    /// </summary>
    public bool HrEditable { get; set; }
+
+    /// <summary>
+    /// 显示排序码。
+    /// </summary>
    public int? SortCode { get; set; }
+
+    /// <summary>
+    /// 业务备注。
+    /// </summary>
    public string Remark { get; set; }
 }

+/// <summary>
+/// 编辑模板变量参数。
+/// </summary>
 public class OnboardingTemplateVariableEditInput : OnboardingTemplateVariableAddInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "变量Id不能为空")]
    public long Id { get; set; }
 }