添加代码注释

zt-module-base/zt-module-base-server/src/main/java/com/zt/plat/module/base/service/tmpltp/TemplateInstanceDataService.java

@@ -80,6 +80,12 @@ public interface TemplateInstanceDataService {
      */
     boolean clearTemplateInstanceData(String instanceId,List<Long> valIds);
 
+    /**
+     * 批量创建实例字段值
+     *
+     * @param createReqVOS 创建参数
+     * @return 实例字段值
+     */
     List<TemplateInstanceDataRespVO>  createBatchTemplateInstanceData(List<TemplateInstanceDataSaveReqVO> createReqVOS);
 
 }

zt-module-base/zt-module-base-server/src/main/java/com/zt/plat/module/base/service/tmpltp/TemplateInstanceItemService.java

@@ -63,5 +63,11 @@ public interface TemplateInstanceItemService {
      */
     PageResult<TemplateInstanceItemDO> getTemplateInstanceItemPage(@Valid TemplateInstanceItemPageReqVO pageReqVO);
 
+    /**
+    * 批量创建实例条款值
+    *
+    * @param createReqVOS 创建信息
+    * @return 批量创建结果
+    */
     List<TemplateInstanceItemRespVO> createBatchTemplateInstanceItem(@Valid List<TemplateInstanceItemSaveReqVO> createReqVOS);
 }

zt-module-base/zt-module-base-server/src/main/java/com/zt/plat/module/base/service/tmpltp/TemplateInstanceService.java

@@ -61,10 +61,26 @@ public interface TemplateInstanceService {
      */
     PageResult<TemplateInstanceDO> getTemplateInstancePage(TemplateInstancePageReqVO pageReqVO);
 
+    /**
+     * 通过实例id获得部门
+     *
+     * @param instanId
+     * @return 获取部门
+     */
     List<String> getDeptByInstanId(Long instanId);
 
+    /**
+     * 发布模板实例
+     *
+     * @param publishReqVOS 发布参数
+     */
     void publishTemplateInstance(List<PublishTemplateInstanceReqVO> publishReqVOS);
 
+    /**
+     * 获取模板实例详情
+     *
+     * @param templateInstanceRespVO 模板实例详情
+     */
     void getDetailedInfo(TemplateInstanceRespVO templateInstanceRespVO);
     /**
      * 获得模板实例分页排除停用状态的
@@ -74,17 +90,49 @@ public interface TemplateInstanceService {
      */
     PageResult<TemplateInstanceDO> listExcludingDisabled(@Valid TemplateInstancePageReqVO pageReqVO);
 
+    /**
+     * 停用启用
+     *
+     * @param reqVO 停用启用参数
+     */
     void setDisableOrEnable(@Valid DisableEnableReqVO reqVO);
 
+    /**
+     * 创建版本
+     *
+     * @param id 模版实例id
+     * @return 创建结果
+     */
     TemplateInstanceRespVO createVersion(@Valid @NotEmpty(message = "模版实例id不能为空") String id);
 
+    /**
+     * 获取版本
+     *
+     * @param id 模版实例id
+     * @return 获取结果
+     */
     Map<String, Object> getVersion(String id);
 
+    /**
+     * 通过模版编码获取模版实例
+     *
+     * @param cdg 模版编码
+     * @return 获取结果
+     */
     List<TemplateInstanceRespVO> listByCdg(String cdg);
 //
 //    Map<String, Object> saveFile(MultipartFile file, String id);
 
+    /**
+     * 通过实例id，更新文件对象
+     * @param id params
+     *
+     */
     void updateTemplateInstanceFileUrlByInstanceId(@Valid @NotEmpty(message = "模版实例id不能为空") String id, @Valid @NotEmpty(message = "文件参数不能为空") String params);
-
+    /**
+     * 获取字段和条款详情
+     * @param id 模版实例id
+     * @return 获取结果
+     */
     FieldAndClauseRespVO getFieldAndClauseDetail(@Valid @NotEmpty(message = "模版实例id不能为空") String id);
 }

zt-module-base/zt-module-base-server/src/main/java/com/zt/plat/module/base/service/tmpltp/TmplItmService.java

@@ -13,11 +13,37 @@ import jakarta.validation.constraints.NotEmpty;
 import java.util.List;
 
 public interface TmplItmService extends IService<TmplItmDO> {
-
+    /**
+     * 创建模板条目
+     *
+     * @param tmplItmSaveReqVO 创建信息
+     * @return 编号
+     */
     TmplItmRespVO createTmplItm(TmplItmSaveReqVO tmplItmSaveReqVO) ;
+    /**
+     * 更新模板条目
+     *
+     * @param tmplItmSaveReqVO 更新信息
+     */
     void updateTmplItm(TmplItmSaveReqVO tmplItmSaveReqVO) ;
+    /**
+     * 删除模板条目
+     *
+     * @param ids 编号
+     */
     boolean deleteTmplItm(List<Long> ids);
-
+    /**
+     * 获得模板条目
+     *
+     * @param pageReqVO 分页请求
+     * @return 模板条目
+     */
     PageResult<TmplItmDO> pageTmplItm(TmpItmPageReqVO pageReqVO);
+    /**
+     * 获得模板条目
+     *
+     * @param ids 编号
+     * @return 模板条目
+     */
     List<TmplItmDO> listTmplItmByIds(@Valid @NotEmpty(message = "ids不能为空") List<String> ids);
 }

zt-module-base/zt-module-base-server/src/main/java/com/zt/plat/module/base/service/tmpltp/TmplTpFldService.java

@@ -13,12 +13,42 @@ import java.util.List;
 import java.util.Map;
 
 public interface TmplTpFldService extends IService<TmplTpFldDO> {
+    /**
+     * 创建模板字段
+     *
+     * @param tmplTpFldSaveReqVO 创建信息
+     * @return 编号
+     */
     TmplFldRespVO createTmplFld(@Valid TmplTpFldSaveReqVO tmplTpFldSaveReqVO);
+    /**
+     * 更新模板字段
+     *
+     * @param tmplTpFldSaveReqVO 更新信息
+     */
     void  updateTmplFld(@Valid TmplTpFldSaveReqVO tmplTpFldSaveReqVO);
+    /**
+     * 获取字段分页
+     *
+     * @param pageReqVO 编号
+     */
     PageResult<TmplTpFldDO>  tmplTpFldPage(TmplFldPageReqVO pageReqVO);
+    /**
+     * 删除模板字段
+     *
+     * @param ids 编号
+     */
     void deleteTmplTpByIds(List< Long> ids);
+    /**
+     * 获取字段列表
+     *
+     * @param clazz  **VO类
+     */
     List<Map<String, Object>>getTmplTpListByClass(String clazz);
-
+    /**
+     * 获取字段列表
+     *
+     * @param valNames 字段名称
+     */
     List<TmplTpFldDO> getTmplTpListByValKeys(List< String> valNames);