添加注释

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/base/IReportService.java

@@ -6,7 +6,7 @@ import io.swagger.annotations.ApiOperation;
 import java.util.List;
 
 /**
- * @Description :
+ * @Description : 自定义报表服务
  * @Reference :
  * @Author : Adair Peng
  * @CreateDate : 2019-01-20 16:04
@@ -14,9 +14,19 @@ import java.util.List;
  **/
 public interface IReportService {
 
+    /**
+     * 自定义HQL 安全检查
+     * @param hql
+     */
     @ApiOperation(value = "HQL 入侵检查",notes = "入侵检查")
     void checkReportHQL(String hql);
 
+    /**
+     * 执行 HQL
+     * @param model HQL Model
+     * @return 查询结果集
+     * @throws Exception 运行异常
+     */
     @ApiOperation(value = "HQL 执行",notes = "执行 HQL")
     List selectTemplateModel(TemplateModel model) throws Exception;
 }

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/base/ISystemInitService.java

@@ -36,6 +36,12 @@ public interface ISystemInitService {
     @ApiOperation(value = "加载语言数据",notes = "加载语言数据")
     void loadSysLocaleLanguage();
 
+    /**
+     * 从缓存获取对象数据
+     * @param key       Redis Key
+     * @param dataType 数据类型
+     * @return
+     */
     @ApiOperation(value = "获取缓存中的数据",notes = "获取缓存中的数据")
     Object getDataFromCache(String key,Class dataType);
 }

modules/i3plus-core-api/src/main/java/cn/estsh/i3plus/core/api/iservice/base/ISystemLoginService.java

@@ -15,21 +15,56 @@ import io.swagger.annotations.ApiOperation;
  **/
 public interface ISystemLoginService {
 
+    /**
+     * 普通用户登录
+     * @param loginName     账号
+     * @param loginPwd      密码
+     * @param languageCode  登录语言
+     * @return 用户会话
+     */
     @ApiOperation(value = "用户登录",notes = "普通用户登录")
-    SessionUser queryUserLogin(String loginName, String s, String languageCode);
+    SessionUser queryUserLogin(String loginName, String loginPwd, String languageCode);
 
+    /**
+     * 管理员登录
+     * @param loginName     账号
+     * @param loginPwd      密码
+     * @param languageCode  登录语言
+     * @return 用户会话
+     */
     @ApiOperation(value = "用户登录",notes = "管理用户登录")
-    SessionUser queryAdminLogin(String loginName, String s, String languageCode);
+    SessionUser queryAdminLogin(String loginName, String loginPwd, String languageCode);
 
+    /**
+     * 用户信息分装
+     * @param authenticationToken
+     * @return  用户会话
+     */
     @ApiOperation(value = "封装用户",notes = "封装普通用户信息")
     SessionUser queryCheckUserLogin(UserToken authenticationToken);
 
+    /**
+     * 管理员登录
+     * @param authenticationToken  登录信息
+     * @return 用户会话
+     */
     @ApiOperation(value = "封装用户",notes = "封装管理员信息")
     SessionUser queryCheckAdminLogin(AdminToken authenticationToken);
 
+    /**
+     *  超级管理员登录
+     * @param authenticationToken  登录信息
+     * @return 用户会话
+     */
     @ApiOperation(value = "封装用户",notes = "封装超级管理员信息")
     SessionUser queryCheckSaAdminLogin(SaAdminToken authenticationToken);
 
+    /**
+     * 记录登录错误
+     * @param loginName 账号
+     * @param sessionId Session ID
+     * @return 用户会话
+     */
     @ApiOperation(value = "登录密码错误",notes = "登录密码错误记录错误次数功能")
     Integer doLoginPasswordError(String loginName,String sessionId);
 }

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

@@ -67,9 +67,19 @@ public interface ICoreTreeService {
     @ApiOperation(value = "获取部门树",notes = "根据父节点获取部门树")
     SysDepartment getSysDepartmentTreeById(long id);
 
+    /**
+     * 获取部门ID集合
+     * @param id 组织ID
+     * @return  部门ID 集合
+     */
     @ApiOperation(value = "获取部门ID集合",notes = "根据组织ID获取部门子集ID集合")
     List<Long> findSysDepartmentIdByOrganizeId(long id);
 
+    /**
+     * 获取指定部门 的子集 ID 集合
+     * @param department 部门信息
+     * @return 子集ID 集合
+     */
     @ApiOperation(value = "获取部门ID集合",notes = "获取部门子集ID集合")
     List<Long> findSysDepartmentChildIds(SysDepartment department);
 
@@ -96,6 +106,11 @@ public interface ICoreTreeService {
     @ApiOperation(value = "获取组织树",notes = "根据父节点获取组织树集合")
     List<SysOrganize> findSysOrganizeTreeByParentId(long parentId);
 
+    /**
+     * 获取组织子集ID 集合
+     * @param organize 组织信息
+     * @return 组织子集ID集合
+     */
     @ApiOperation(value = "获取组织子集ID集合",notes = "获取组织子集ID集合")
     List<Long> findSysOrganizeChildIds(SysOrganize organize);
 
@@ -146,12 +161,30 @@ public interface ICoreTreeService {
     @ApiOperation(value = "封装菜单树",notes = "封装当前菜单树")
     void findSysMenuChildrenTreePack(SysMenu parent, int step);
 
+    /**
+     * 根据角色ID 分装功能菜单 子集分装
+     * @param parent 功能菜单
+     * @param roleId  角色ID
+     * @param step  层级
+     */
     @ApiOperation(value = "封装菜单树",notes = "根据角色ID封装当前菜单树")
     void findSysMenuChildrenTreeByRoleIdPack(SysMenu parent,Long roleId, int step);
 
+    /**
+     * 根据用户ID 分装功能菜单 子集分装
+     * @param parent 目录信息
+     * @param userId 用户ID
+     * @param step 层级
+     */
     @ApiOperation(value = "封装菜单树",notes = "根据用户ID封装当前菜单树")
     void findSysMenuChildrenTreeByUserIdPack(SysMenu parent,Long userId, int step);
 
+    /**
+     * 功能菜单 子集分装
+     * @param parent 主功能信息
+     * @param cacheMenuList 功能菜单集合
+     * @param step 层级
+     */
     @ApiOperation(value = "封装菜单树",notes = "根据用户ID 内存中封装当前菜单树")
     void findMemSysMenuChildrenTreeByUserIdPack(SysMenu parent, List<SysMenu> cacheMenuList, int step);
 

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

@@ -17,9 +17,19 @@ import java.util.List;
  **/
 public interface IPersonnelService {
 
+    /**
+     * 保存账号信息
+     * @param user 账号信息
+     * @return 保存之后的账号信息
+     */
     @ApiOperation(value = "保存账号")
     SysUser saveSysUser(SysUser user);
 
+    /**
+     * 保存用户信息
+     * @param info 账号信息
+     * @return 保存后的账号信息
+     */
     @ApiOperation(value = "保存用户")
     SysUserInfo saveSysUserInfo(SysUserInfo info);