// Copyright (c) 2022-Now 少林寺驻北固山办事处大神父王喇嘛
//
// SimpleAdmin 基于 Apache License Version 2.0 协议发布，可用于商业项目，但必须遵守以下补充条款:
// 1.请不要删除和修改根目录下的LICENSE文件。
// 2.请不要删除和修改SimpleAdmin源码头部的版权声明。
// 3.分发源码时候，请注明软件出处 https://gitee.com/dotnetmoyu/SimpleAdmin
// 4.基于本软件的作品，只能使用 SimpleAdmin 作为后台服务，除外情况不可商用且不允许二次分发或开源。
// 5.请不得将本软件应用于危害国家安全、荣誉和利益的行为，不能以任何形式用于非法为目的的行为。
// 6.任何基于本软件而产生的一切法律纠纷和责任，均于我司无关。

namespace SimpleAdmin.Application;

/// <summary>
/// 合同模板变量定义，描述 DOCX 占位符、来源类型及填写规则。
/// </summary>
[SugarTable("ob_template_variable", TableDescription = "合同模板变量定义")]
[Tenant(SqlSugarConst.DB_DEFAULT)]
public class ObTemplateVariable : BaseEntity
{
    /// <summary>
    /// 合同模板版本 Id。
    /// </summary>
    public long TemplateVersionId { get; set; }

    /// <summary>
    /// DOCX 中使用的变量编码。
    /// </summary>
    public string VariableCode { get; set; }

    /// <summary>
    /// 变量显示名称。
    /// </summary>
    public string VariableName { get; set; }

    /// <summary>
    /// 变量来源类型，例如员工、公司、合同或系统。
    /// </summary>
    public string VariableType { get; set; }

    /// <summary>
    /// 变量数据类型。
    /// </summary>
    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; }
}