// 声明该类所在的包，明确其在项目模块中的位置
package com.yf.exam.modules.sys.user.dto.request;

// 导入 Swagger 注解，用于在生成 API 文档时描述类的信息
import io.swagger.annotations.ApiModel;
// 导入 Swagger 注解，用于在生成 API 文档时描述类属性的信息
import io.swagger.annotations.ApiModelProperty;
// 导入 Lombok 的 Data 注解，自动生成 getter、setter、equals、hashCode 和 toString 方法
import lombok.Data;

// 导入 Serializable 接口，使该类的对象可以进行序列化和反序列化操作
import java.io.Serializable;
// 导入 List 接口，用于存储角色 ID 列表
import java.util.List;

/**
 * <p>
 * 管理员保存请求类，用于封装管理员信息保存操作所需的请求参数。
 * 该类作为数据传输对象，在不同层之间传递管理员保存相关的数据。
 * </p>
 *
 * @author 聪明笨狗
 * @since 2020-04-13 16:57
 */
// 使用 Lombok 的 Data 注解，自动生成常用的 getter、setter 等方法
@Data
// 使用 Swagger 的 ApiModel 注解，为 API 文档描述该类的信息
@ApiModel(value="管理员保存请求类", description="管理员保存请求类")
public class SysUserSaveReqDTO implements Serializable {

    // 序列化版本号，确保序列化和反序列化时类的版本一致性
    private static final long serialVersionUID = 1L;

    /**
     * 管理员的唯一标识 ID
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "ID", required=true)
    private String id;

    /**
     * 管理员的用户名，用于系统登录和身份识别
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "用户名", required=true)
    private String userName;

    /**
     * 管理员的头像链接，用于在系统中展示管理员的头像
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "头像", required=true)
    private String avatar;

    /**
     * 管理员的真实姓名，用于在系统中进行更准确的身份识别和展示
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "真实姓名", required=true)
    private String realName;

    /**
     * 管理员的登录密码，用于系统登录验证
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "密码", required=true)
    private String password;

    /**
     * 管理员所属部门的 ID，用于关联管理员所在的部门信息
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "部门", required=true)
    private String departId;

    /**
     * 管理员拥有的角色列表，存储角色的 ID 集合
     * 在 API 文档中标记为必需项，表明保存操作时该字段必须提供
     */
    @ApiModelProperty(value = "角色列表", required=true)
    private List<String> roles;
    
}