添加注释

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/busi/ISysOrderNoRuleService.java

@@ -16,33 +16,80 @@ import java.util.List;
  **/
 public interface ISysOrderNoRuleService {
 
+    /**
+     * 添加单号规则
+     * @param sysOrderNoRule 单号信息
+     * @return 新增后的单号信息
+     */
     @ApiOperation(value = "添加单号规则")
     SysOrderNoRule insertSysOrderNoRule(SysOrderNoRule sysOrderNoRule);
 
+    /**
+     * 修改单号信息
+     * @param sysOrderNoRule
+     */
     @ApiOperation(value = "修改单号规则")
     void updateSysOrderNoRule(SysOrderNoRule sysOrderNoRule);
 
+    /**
+     * 删除单号信息
+     * @param id 单号ID
+     */
     @ApiOperation(value = "根据id删除单号规则")
     void deleteSysOrderNoRuleById(Long id);
 
+    /**
+     * 根据ID 查询单号
+     * @param id 单号ID
+     * @return 单号信息
+     */
     @ApiOperation(value = "根据id查询单号规则")
     SysOrderNoRule getSysOrderNoRuleById(Long id);
 
+    /**
+     * 获取分页单号信息
+     * @param sysOrderNoRule 单号查询条件
+     * @param pager 分页条件
+     * @return 分页后的查询集合
+     */
     @ApiOperation(value = "单号规则复杂查询，分页，排序")
     ListPager querySysOrderNoRuleByPager(SysOrderNoRule sysOrderNoRule, Pager pager);
 
+    /**
+     * 根据单号代码获取单号信息
+     * @param code 单号代码
+     * @return 单号信息
+     */
     @ApiOperation(value = "根据code查询最新单号规则")
     SysOrderNoRule getSysOrderNoRuleCode(String code);
 
+    /**
+     * 根据id修改单号规则状态
+     * @param id 单号ID
+     * @param status  单号状态
+     */
     @ApiOperation(value = "根据id修改单号规则状态")
     void updateSysOrderNoRuleCodeStatusById(Long id,Integer status);
 
+    /**
+     * 批量删除单号信息
+     * @param ids 单号ID集合
+     */
     @ApiOperation(value = "批量删除单号规则")
     void deleteSysOrderNoRuleByIds(Long[] ids);
 
-    @ApiOperation(value = "批量修改单号规则状态")
+    /**
+     * 批量修改编号规则状态
+     * @param ids 编ID集合
+     * @param status 编号状态
+     */
+    @ApiOperation(value = "批量修改编号规则状态")
     void updateSysOrderNoRuleByIds(Long[] ids,Integer status);
 
+    /**
+     * 批量添加编号规则
+     * @param sysOrderNoRuleList 编号集合
+     */
     @ApiOperation(value = "批量添加编号规则")
     void insertSysOrderNoRuleList(List sysOrderNoRuleList);
 }

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/busi/ISysRoleService.java

@@ -102,18 +102,33 @@ public interface ISysRoleService {
     @ApiOperation(value = "查信角色信息",notes = "查询所有角色信息")
     List<SysRole> findSysRoleAll();
 
+    /**
+     * 根据ID集合查询角色信息
+     * @param ids ID集合
+     * @return 角色集合
+     */
     @ApiOperation(value = "查信角色信息",notes = "查询指定角色信息")
     List<SysRole> findSysRoleByInId(Long[] ids);
 
+    /**
+     * 查询角色信息
+     * @param ids 角色ID 集合
+     * @param status 角色 状态
+     * @return 角色集合
+     */
     @ApiOperation(value = "查信角色信息",notes = "根据ID + 角色状态查询角色信息")
     List<SysRole> findSysRoleByInIdAndStatus(Long[] ids,Integer status);
 
+    /**
+     * 获取用户的角色信息
+     * @param user  账号信息
+     * @return 角色集合
+     */
     @ApiOperation(value = "查信用户的所有角色信息",notes = "查信用户的所有角色信息")
     List<SysRole> findSysRoleByUser(SysUser user);
 
     /**
      * 根据id 数据
-     *
      * @param id
      * @return
      */
@@ -129,6 +144,10 @@ public interface ISysRoleService {
     @ApiOperation(value = "查信角色信息",notes = "查询角色信息(分页/组合)")
     ListPager<SysRole> querySysRole(SysRole role, Pager pager);
 
+    /***
+     * 检查角色唯一性
+     * @param role 角色信息
+     */
     @ApiOperation(value = "角色唯一检查")
     void checkSysRoleOnly(SysRole role);
 

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/busi/ISysUserInfoService.java

@@ -121,6 +121,11 @@ public interface ISysUserInfoService {
     @ApiOperation(value = "关系查询-用户部门",notes = "查询用户部门关系")
     List<SysRefUserDepartment> findRefUserDepartmentByUserId(Long userId);
 
+    /**
+     * 根据部门或者组织集合查询用户部门关系
+     * @param model 用户模型
+     * @return 账号部门关系集合
+     */
     @ApiOperation(value = "关系查询-用户部门",notes = "根据部门或者组织集合查询用户部门关系")
     List<SysRefUserDepartment> querySysRefUserDepartment(UserDetailModel model);
 
@@ -141,6 +146,12 @@ public interface ISysUserInfoService {
     @ApiOperation(value = "查询用户信息",notes = "根据组织、部门、名称+工号组合查询条件查询用户信息")
     List<SysUserInfo> querySysUserInfoList(SysUserInfo info, List<Long> idList);
 
+    /**
+     * 查询用户信息
+     * @param model   用户模型
+     * @param idList
+     * @return 用户信息集合
+     */
     @ApiOperation(value = "查询用户信息",notes = "根据组织、部门、名称+工号组合查询条件查询用户信息")
     List<SysUserInfo> querySysUserInfoList(UserDetailModel model, List<Long> idList);
 

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/busi/ISysUserService.java

@@ -117,9 +117,19 @@ public interface ISysUserService {
     @ApiOperation(value = "查询所有",notes = "查询所有账号信息")
     List<SysUser> list();
 
+    /**
+     * 根据角色查询用户信息
+     * @param roleId 角色ID
+     * @return 获取用户ID 集合
+     */
     @ApiOperation(value = "查询用户ID 集合",notes = "根据角色Id 查询用户ID集合")
     List<Long> findSysUserIdListByRoleId(Long roleId);
 
+    /***
+     * 根据 部门ID 获取用户ID
+     * @param idList 部门集合
+     * @return 用户ID集合
+     */
     @ApiOperation(value = "查询用户ID 集合",notes = "根据部门Id 查询用户ID集合")
     List<Long> findSysUserIdListByDepartmentId(List<Long> idList);
 
@@ -214,6 +224,10 @@ public interface ISysUserService {
     @ApiOperation(value = "账号检查",notes = "检查账号信息唯一(登录名、邮箱、手机号)")
     void checkSysUserOnly(SysUser user);
 
+    /**
+     * 获取用户数量
+     * @return 用户数量
+     */
     @ApiOperation(value = "查询账户数量")
     long getSysUserCount();
 

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/busi/ISystemResourceService.java

@@ -16,27 +16,88 @@ import java.util.List;
  **/
 public interface ISystemResourceService {
 
+    /**
+     * 新增语言信息
+     * @param lang 语言对象
+     * @return 新增后的语言信息
+     */
     SysLocaleLanguage insertSysLocaleLanguage(SysLocaleLanguage lang);
 
+    /**
+     * 修改语言信息
+     * @param lang  语言对象
+     * @return 修改后的语言对象
+     */
     SysLocaleLanguage updateSysLocaleLanguage(SysLocaleLanguage lang);
 
+    /**
+     * 删除语言信息
+     * @param id
+     */
     void deleteSysLocaleLanguageById(long id);
 
+    /**
+     * 查询语言信息
+     * @param lang  语言信息查询条件
+     * @return  语言集合
+     */
     List<SysLocaleLanguage> listSysLocaleLanguage(SysLocaleLanguage lang);
 
+    /**
+     * 语言信息分页查询
+     * @param lang 语言信息查询条件
+     * @param pager 分页信息
+     * @return 分页后的语言信息
+     */
     ListPager<SysLocaleLanguage> listSysLocaleLanguageByPager(SysLocaleLanguage lang, Pager pager);
 
+    /**
+     * 新增本地资源
+     * @param res 资源信息
+     * @return 新增后的资源信息
+     */
     SysLocaleResource insertSysLocaleResource(SysLocaleResource res);
 
+    /**
+     * 修改资源信息
+     * @param res 资源信息
+     * @return 修改后的资源信息
+     */
     SysLocaleResource updateSysLocaleResource(SysLocaleResource res);
 
+    /**
+     * 删除资源信息
+     * @param id 资源ID
+     */
     void deleteSysLocaleResourceById(long id);
 
+    /**
+     * 批量删除资源信息
+     * @param ids 资源ID集合
+     */
     void deleteSysLocaleResourceByIds(Long[] ids);
 
+    /**
+     * 资源信息分页查询
+     * @param res  资源信息查询条件
+     * @param pager 分页条件
+     * @return 资源信息分页集合
+     */
     ListPager<SysLocaleResource> listSysLocaleResourceByPager(SysLocaleResource res,Pager pager);
 
+    /**
+     * 资源信息查询
+     * @param res 资源信息查询条件
+     * @return 资源信息集合
+     */
     List<SysLocaleResource> listSysLocaleResource(SysLocaleResource res);
 
+    /**
+     * 获取单个资源信息
+     * @param resourceType 资源类型
+     * @param langCode 资源编码
+     * @param langKey 资源Key
+     * @return 资源信息
+     */
     SysLocaleResource getSysLocaleResourceByLanguage(int resourceType,String langCode,String langKey);
 }