ludc
2023-09-08 caeb0c1b3666655e2e05292c2fcaef82a9808cd1
Source/UBCS/ubcs-service/ubcs-code/src/main/java/com/vci/ubcs/code/service/MdmEngineService.java
@@ -1,22 +1,34 @@
package com.vci.ubcs.code.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.vci.ubcs.code.applyjtcodeservice.vo.BaseModelVO;
import com.vci.ubcs.code.bo.CodeClassifyFullInfoBO;
import com.vci.ubcs.code.entity.CodeAllCode;
import com.vci.ubcs.code.vo.pagemodel.CodeClassifyTemplateVO;
import com.vci.ubcs.code.vo.pagemodel.CodeRuleVO;
import com.vci.ubcs.code.bo.CodeTemplateAttrSqlBO;
import com.vci.ubcs.code.dto.CodeDeleteBatchDTO;
import com.vci.ubcs.code.dto.CodeOrderDTO;
import com.vci.ubcs.code.dto.datapush.BaseModelDTO;
import com.vci.ubcs.code.vo.CodeKeyAttrRepeatVO;
import com.vci.ubcs.code.vo.pagemodel.UITableFieldVO;
import com.vci.ubcs.code.vo.pagemodel.*;
import com.vci.ubcs.flow.core.dto.FlowStatusDTO;
import com.vci.ubcs.starter.exception.VciBaseException;
import com.vci.ubcs.starter.revision.model.BaseModel;
import com.vci.ubcs.starter.revision.model.TreeQueryObject;
import com.vci.ubcs.starter.web.pagemodel.*;
import com.vci.ubcs.starter.web.util.VciQueryWrapperForDO;
import org.springblade.core.tool.api.R;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
 * 主数据引擎服务
 * @author weidy
 * @date 2022-2-21
 */
public interface MdmEngineService extends IService<CodeAllCode> {
public interface MdmEngineService {
   /**
    * 使用分类的主键获取可以使用的模板对象
    * @param codeClassifyOid 分类的主键
@@ -32,112 +44,414 @@
    */
   CodeClassifyTemplateVO getUsedTemplateByClassifyOid(String codeClassifyOid, boolean hasAttr);
   /**
    * 获取枚举的下拉选项
    * @param attrVO 模板属性的对象
    * @return 下拉选项
    */
   List<KeyValue> listComboboxItems(CodeClassifyTemplateAttrVO attrVO);
   /**
    * 修改状态
    * @param baseModelDTO 数据传输对象
    */
   void changeStatus(BaseModelDTO baseModelDTO);
   /**
    * 申请单一编码
    * @param orderDTO 申请的信息,需要包含属性的内容和码段相关的内容
    * @return 返回编码的内容
    */
   String addSaveCode(CodeOrderDTO orderDTO) throws Exception;
   /**
    * 判断编码的码段是否输入或者选择了码值
    * @param ruleVO 规则的显示对象
    * @param orderDTO 编码申请的内容
    */
   void checkSecValueOnOrder(CodeRuleVO ruleVO, CodeOrderDTO orderDTO);
   /**
    * 封装关键属性的查询语句
    *
    * @param value        当前的值
    * @param keyRuleVO    关键属性的控制规则,可以为空
    * @param attrId       属性的编号
    * @param trim         是否去除空格
    * @param ignoreCase   是否不区分大小写
    * @param ignoreWidth  是否忽略全半角
    * @param trimAll      是否忽略全部空格
    * @param conditionMap 查询条件
    */
   void wrapperKeyAttrConditionMap(String value, CodeKeyAttrRepeatVO keyRuleVO, String attrId,
                        boolean trim, boolean ignoreCase, boolean ignoreWidth,
                        boolean trimAll, Map<String, String> conditionMap);
   /**
    * 初始化业务类型
    * --创建人默认为当前用户,如果需要修改,可以在获取后自行处理
    * @param btmName 业务类型的名称,会自动变成小写
    * @return BaseModel
    */
   BaseModel createCBOByBtmName(String btmName);
   /**
    * 保存可输可选的信息
    *
    * @param templateVO 模板的对象
    * @param cboList    数据的内容
    */
   void batchSaveSelectChar(CodeClassifyTemplateVO templateVO, /*List<ClientBusinessObject> cboList*/
                      List<BaseModel> cboList);
   /**
    * 封装开关的内容,常用于导出
    * @param dataMap 数据的内容
    * @param templateVO 模板的显示
    */
   void wrapperBoolean(List<Map<String, String>> dataMap, CodeClassifyTemplateVO templateVO);
   /**
    * 使用模板的主键获取表单的信息
    * @param templateOid 模板的主键
    * @param codeClassifyOid 使用模板的分类的主键
    * @return ui相关的内容
    */
    MdmUIInfoVO getFormDefineByTemplateOid(String templateOid, String codeClassifyOid);
   /**
    * 模板属性转换为表单的字段
    *
    * @param attrVO  模板属性
    * @param btmType 业务类型
    * @return 表单的字段
    */
   UIFormItemVO templateAttr2FormField(CodeClassifyTemplateAttrVO attrVO, String btmType) ;
   /**
    * 模板属性转换为表格显示的配置
    *
    * @param attrVO 模板属性
    * @param forEdit 是否是编辑所需
    * @return 表格的字段
    */
   UITableFieldVO templateAttr2TableField(CodeClassifyTemplateAttrVO attrVO, boolean forEdit);
   /**
    * 相似项查询
    * @param orderDTO 编码的相关信息
    * @return 数据列表
    */
   DataGrid<Map<String, String>> resembleQuery(CodeOrderDTO orderDTO);
   /**
    * 修改主题库数据
    * @param orderDTO 数据的内容,不用包含码段的内容了
    */
   void editSaveCode(CodeOrderDTO orderDTO);
   /**
    * 封装相似项查询的查询条件的映射
    *
    * @param value          值
    * @param resembleRuleVO 相似项规则
    * @param attrId         属性的编号
    * @param conditionMap   查询条件
    */
   void wrapperResembleConditionMap(String value, CodeResembleRuleVO resembleRuleVO, String attrId, Map<String, String> conditionMap);
   /**
    * 获取使用的相似查询规则
    *
    * @param fullInfoBO        类全部信息
    * @param currentClassifyVO 当前的分类
    * @return 规则,如果不存在会返回Null
    */
   CodeResembleRuleVO getUseResembleRule(CodeClassifyFullInfoBO fullInfoBO, CodeClassifyVO currentClassifyVO);
   /**
    * 查询编码数据的列表
    *
    * @param btmType      业务类型
    * @param templateVO   模板的对象,需要包含模板的属性
    * @param conditionMap 查询条件
    * @param pageHelper   分页对象
    * @return 数据列表
    */
   DataGrid<Map<String, String>> queryGrid(String btmType, CodeClassifyTemplateVO templateVO, Map<String, String> conditionMap, PageHelper pageHelper);
   /**
    * 封装查询出来的数据
    *
    * @param dataMap              数据的映射
    * @param templateVO           模板的属性
    * @param onlySelectAttrIdList 仅仅查询的属性字段
    * @param form 表单里使用
    */
   void wrapperData(List<Map<String, String>> dataMap, CodeClassifyTemplateVO templateVO,
                Collection<String> onlySelectAttrIdList, boolean form);
   /**
    * 根据模板属性生成相应的sql信息
    *
    * @param btmType      业务类型
    * @param templateVO   模板显示对象,必须包含属性
    * @param conditionMap 查询条件
    * @param pageHelper   分页和排序对象
    * @return sql的相关信息
    */
   CodeTemplateAttrSqlBO getSqlByTemplateVO(String btmType, CodeClassifyTemplateVO templateVO, Map<String, String> conditionMap, PageHelper pageHelper);
   void deleteCode(CodeDeleteBatchDTO deleteBatchDTO);
   /**
    * 使用分类和阶段的编号,获取包含的属性
    * @param codeClassifyOid 分类的主键
    * @param phase 阶段的名称
    * @return 属性的英文名称
    */
   List<String> listPhaseAttrByClassifyOid(String codeClassifyOid, String phase);
   /**
    * 路径上包含当前分类的所有分类信息
    * @param codeClassifyOid 分类的主键
    * @return 分类树
    */
   List<Tree> hasSelfClassifyTree(String codeClassifyOid);
   /**
    * 使用分类获取对应的数据
    * @param codeClassifyOid 分类的主键
    * @param templateOid 模板的主键
    * @param conditionMap 查询条件
    * @param pageHelper 分页的对象
    * @return 数据(包含下级分类)
    */
   DataGrid<Map<String, String>> gridTableDataByClassifyOid(String codeClassifyOid, String templateOid, Map<String, String> conditionMap, PageHelper pageHelper);
   /**
    * 批量保存流程执行页面修改的内容
    * @param orderDTOList 编码相关的信息,不需要码段的信息
    * @return 执行结果
    */
   R batchUpdateCode(List<CodeOrderDTO> orderDTOList);
   /**
    * 标记流程中业务数据是否通过
    * @param oid 业务数据主键
    * @param btmName 业务类型
    * @param pass 是否通过
    * @return 执行结果
    */
   R markDataPassing(String oid, String btmName, Boolean pass);
   /**
    * 预览组合规则
    * @param orderDTO 申请编码的信息
    * @return key是组合规则的属性。value是组合后的值,。如果缺少某个属性的值,会作为value返回
    */
   Map<String,String> previewCompRule(CodeOrderDTO orderDTO);
   /**
    * 分类注入的内容预览
    * @param codeClassifyOid 分类的主键
    * @param templateOid 模板的主键
    * @return key是分类注入的属性,value是注入后的值
    */
   Map<String, String> previewClassify(String codeClassifyOid, String templateOid);
   /**
    * 升版的主题库数据
    * @param orderDTO 数据的内容,不需要包含码段的内容
    */
   void upSaveCode(CodeOrderDTO orderDTO);
   /**
    * 使用码段的主键获取分类的码值内容
    * @param classifySecOid 码段的主键
    * @param parentClassifyValueOid 上级分类的主键
    * @return 分类码值的内容
    */
   List<CodeClassifyValueVO> listCodeClassifyValueBySecOid(String classifySecOid, String parentClassifyValueOid);
   /**
    * 使用主题库分类获取编码规则
    * @param codeClassifyOid 分类的主键
    * @return 编码规则的内容
    */
   CodeRuleVO getCodeRuleByClassifyOid(String codeClassifyOid);
   /**
    * 使用分类的全部信息获取编码规则
    *
    * @param fullInfoBO 分类的全部信息
    * @return 规则的内容
    */
   CodeRuleVO getCodeRuleByClassifyFullInfo(CodeClassifyFullInfoBO fullInfoBO);
////
////   /**
////    * 获取枚举的下拉选项
////    * @param attrVO 模板属性的对象
////    * @return 下拉选项
////    */
////   List<KeyValue> listComboboxItems(CodeClassifyTemplateAttrVO attrVO);
////
////   /**
////    * 修改状态
////    * @param baseModelDTO 数据传输对象
////    */
////   void changeStatus(BaseModelDTO baseModelDTO);
////
////   /**
////    * 申请单一编码
////    * @param orderDTO 申请的信息,需要包含属性的内容和码段相关的内容
////    * @return 返回编码的内容
////    */
////   String addSaveCode(CodeOrderDTO orderDTO);
////
////   /**
////    * 判断编码的码段是否输入或者选择了码值
////    * @param ruleVO 规则的显示对象
////    * @param orderDTO 编码申请的内容
////    */
////   void checkSecValueOnOrder(CodeRuleVO ruleVO, CodeOrderDTO orderDTO);
////
////   /**
////    * 封装关键属性的查询语句
////    *
////    * @param value        当前的值
////    * @param keyRuleVO    关键属性的控制规则,可以为空
////    * @param attrId       属性的编号
////    * @param trim         是否去除空格
////    * @param ignoreCase   是否不区分大小写
////    * @param ignoreWidth  是否忽略全半角
////    * @param trimAll      是否忽略全部空格
////    * @param conditionMap 查询条件
////    */
////   void wrapperKeyAttrConditionMap(String value, CodeKeyattrrepeatVO keyRuleVO, String attrId,
////                        boolean trim, boolean ignoreCase, boolean ignoreWidth,
////                        boolean trimAll, Map<String, String> conditionMap);
////   /**
////    * 初始化业务类型
////    * --创建人默认为当前用户,如果需要修改,可以在获取后自行处理
////    * @param btmName 业务类型的名称,会自动变成小写
////    * @return CodeWupinEntity
////    * @throws VciBaseException 初始化出错的是会抛出异常
////    */
////   CodeWupinEntity createCBOByBtmName(String btmName);
////
////   /**
////    * 保存可输可选的信息
////    *
////    * @param templateVO 模板的对象
////    * @param cboList    数据的内容
////    */
////   void batchSaveSelectChar(CodeClstemplateVO templateVO, /*List<ClientBusinessObject> cboList*/
////                      List<String> cboList);
////
////   /**
////    * 使用模板的主键获取表单的信息
////    * @param templateOid 模板的主键
////    * @param codeClassifyOid 使用模板的分类的主键
////    * @return ui相关的内容
////    */
////    MdmUIInfoVO getFormDefineByTemplateOid(String templateOid, String codeClassifyOid);
////
////   /**
////    * 模板属性转换为表单的字段
////    *
////    * @param attrVO  模板属性
////    * @param btmType 业务类型
////    * @return 表单的字段
////    */
////   UIFormItemVO templateAttr2FormField(CodeClstempattrVO attrVO, String btmType) ;
////
////   /**
////    * 模板属性转换为表格显示的配置
////    *
////    * @param attrVO 模板属性
////    * @param forEdit 是否是编辑所需
////    * @return 表格的字段
////    */
////   UITableFieldVO templateAttr2TableField(CodeClstempattrVO attrVO, boolean forEdit);
////
////   /**
////    * 相似项查询
////    * @param orderDTO 编码的相关信息
////    * @return 数据列表
////    */
////   DataGrid<Map<String, String>> resembleQuery(CodeOrderDTO orderDTO);
////
////   /**
////    * 修改主题库数据
////    * @param orderDTO 数据的内容,不用包含码段的内容了
////    */
////   void editSaveCode(CodeOrderDTO orderDTO);
}
   /**
    * 使用数据主键获取数据的全部信息
    * @param oid 主键
    * @param templateOid 模板的主键
    * @return 数据的内容
    */
   R<List<Map<String, String>>> getDataByOid(String oid, String templateOid);
   /**
    * 使用分类模板主键+模板流程名称获取在审批页面上左侧显示的属性
    * @param templateOid 分类模板的主键
    * @param executionId 流程执行id
    * @param processUse 流程的用途
    * @return 树节点显示的名称
    */
   List<String> getFieldByProcessTemplate(String templateOid, String executionId, String processUse);
   /**
    * 使用分类的主键获取业务数据
    * @param btmType 业务类型
    * @param queryObject 查询对象
    * @return 表格的显示对象值
    */
   DataGrid<Map<String, String>> getTableDataByExecutionId(String btmType, BaseQueryObject queryObject);
   /**
    * 使用分类的主键获取表格的定义
    * @param codeClassifyOid 分类主键
    * @param phase 阶段的名称
    * @return UI相关的信息(仅包含表单)
    */
    MdmUIInfoVO getTableDefineByClassifyOid_v2(String codeClassifyOid, String phase);
   /**
    * 使用分类的编号路径,获取表单的相关定义
    * @param idPath 编号的路径,必须从顶层节点开始,xx/yyy/zz
    * @return UI相关的信息(仅包含表单)
    */
   MdmUIInfoVO getFormDefineByClassifyIdPath(String idPath);
   /**
    * 使用主题库分类的主键获取表单的信息
    *
    * @param codeClassifyOid 分类的主键
    * @return ui相关的内容
    */
   MdmUIInfoVO getFormDefineByClassifyOid(String codeClassifyOid);
   /**
    * 使用模板主键获取ui相关的内容
    * @param templateOid 模板的主键
    * @return ui相关的内容
    */
   MdmUIInfoVO getTableDefineByTemplateOid(String templateOid);
   /**
    * 使用分类的编号路径,获取表格的相关定义
    * @param codeClassifyIdPath 分类的编号路径,必须是从顶层节点开始,xxx/yy/zz这样的格式
    * @param functionId 功能的编号
    * @return UI相关的信息(仅包含表格)
    */
   MdmUIInfoVO getUIInfoByClassifyIdPath(String codeClassifyIdPath, String functionId);
   /**
    * 使用模板主键获取工具栏中的按钮信息
    *
    * @param templateOid 模板的主键
    * @return 按钮的信息,会按照排序号进行排序
    */
   List<CodeButtonVO> listButtonInToolbarByTemplateOid(String templateOid);
   /**
    * 使用分类主键获取工具栏中的按钮信息
    *
    * @param codeClassifyOid 分类的主键
    * @return 按钮的信息,会按照排序号进行排序
    */
   List<CodeButtonVO> listButtonInToolbarByClassifyOid(String codeClassifyOid);
   /**
    * 使用分类主键获取页面的内容,包含按钮
    *
    * @param codeClassifyOid 主题库分类主键
    * @param functionId      功能的编号
    * @return UI相关的内容
    */
   MdmUIInfoVO getUIInfoByClassifyOid(String codeClassifyOid, String functionId);
   /**
    * 使用分类主键,模板主键,阶段标识,流程模板kek获取流程审批中页面的内容,包含按钮
    *
    * @param codeClassifyOid 主题库分类主键
    * @param functionId      功能的编号,默认5
    * @return UI相关的内容
    */
   MdmUIInfoVO getFlowUIInfoByClassifyOid(String codeClassifyOid, String functionId,String templateId,String taskId,String modelKey);
   /**
    * 传入业务类型以及相关数据进行批量插入操作
    *
    * @param btmType 业务类型
    * @param baseModels      处理数据
    * @return 处理成功数据条数
    */
   Integer insertBatchByType(String btmType, List<BaseModel> baseModels);
   /**
    * 传入业务类型以及相oid集合查询数据进行返回
    *
    * @param btmType 业务类型
    * @param oids      需要查询的oid集合 逗号分开
    * @return 查询出的数据
    */
   List<BaseModel> selectByTypeAndOid(String btmType, String oids) ;
   /**
    * 传入业务类型以及相关数据进行批量更新操作
    *
    * @param btmType 业务类型
    * @param baseModels      处理数据
    * @return 处理状态
    */
   R updateBatchByBaseModel(String btmType, List<BaseModel> baseModels);
   /**
    * 默认列表
    * @param referConfigVO
    * @return
    */
   IPage<BaseModelVO> referDataGrid(UIFormReferVO referConfigVO, BaseQueryObject baseQueryObject) throws VciBaseException;
   /**
    * 获取树形的参照
    * @param referConfigVO 参照的配置
    * @return 树形的数据
    */
   List<Tree> referTree(UIFormReferVO referConfigVO, TreeQueryObject queryObject);
   /**
    * 是否为修改忽略的属性
    * @param attrName 属性的名字
    * @return true 表示应该忽略
    */
   default boolean checkUnAttrUnEdit(String attrName){
      return  (VciQueryWrapperForDO.OID_FIELD.equalsIgnoreCase(attrName)
         ||"ts".equalsIgnoreCase(attrName)
         || "lastmodifier".equalsIgnoreCase(attrName)
         || "lastmodifytime".equalsIgnoreCase(attrName)
         || "createtime".equalsIgnoreCase(attrName)
         || "checkintime".equalsIgnoreCase(attrName)
         ||"checkouttime".equalsIgnoreCase(attrName));
   }
   /**
    * 流程中变更状态值
    * @param flowDTO
    * @return
    */
    R processChangeStatus(FlowStatusDTO flowDTO);
   /**
    * 校验关键属性
    * @param orderDTO         编码申请的相关的信息
    */
   public List<Map>  checkKeyAttrOnOrderFordatas(CodeOrderDTO orderDTO) ;
   }