namespace SimpleAdmin.Application;

/// <summary>
/// 全局合同变量字典定义表。
/// 包含标准入职登记表变量、人事合同变量及企业自定义变量。
/// </summary>
[SugarTable("ob_variable_definition", TableDescription = "合同变量字典定义")]
[Tenant(SqlSugarConst.DB_DEFAULT)]
public class ObVariableDefinition : BaseEntity
{
    /// <summary>
    /// 变量全编码，如 employee.EmployeeName, hr.BaseSalary, company.CompanyName, system.TaskNo。
    /// </summary>
    public string VariableCode { get; set; }

    /// <summary>
    /// 变量中文显示名称，如“员工姓名”、“基本工资”。
    /// </summary>
    public string VariableName { get; set; }

    /// <summary>
    /// 变量作用域分类：employee(员工变量), hr(人事参数), company(公司变量), system(系统变量)。
    /// </summary>
    public string VariableCategory { get; set; }

    /// <summary>
    /// 数据类型：string, number, date, multiline。
    /// </summary>
    public string DataType { get; set; } = "string";

    /// <summary>
    /// 默认值或占位提示。
    /// </summary>
    public string DefaultValue { get; set; }

    /// <summary>
    /// 是否为入职登记表内置字段（内置字段不可删，且第1步自动收集）。
    /// </summary>
    public bool IsBuiltIn { get; set; } = false;

    /// <summary>
    /// 是否必填。
    /// </summary>
    public bool Required { get; set; } = false;

    /// <summary>
    /// 排序码。
    /// </summary>
    public int SortCode { get; set; } = 100;

    /// <summary>
    /// 变量说明/备注。
    /// </summary>
    public string Remark { get; set; }
}