package org.springblade.code.service;


import com.vci.mdm.dto.CodeResembleRuleDTO;
import com.vci.mdm.model.CodeResembleRuleDO;
import com.vci.mdm.pagemodel.CodeResembleRuleVO;
import com.vci.starter.web.exception.VciBaseException;
import com.vci.starter.web.pagemodel.BaseResult;
import com.vci.starter.web.pagemodel.DataGrid;
import com.vci.starter.web.pagemodel.PageHelper;

import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * 相似查询规则服务接口
 *
 * @author weidy
 * @date 2022-04-10
 */
public interface CodeResembleRuleServiceI {
    /**
     * 查询所有的相似查询规则
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 执行结果
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<CodeResembleRuleVO> gridCodeResembleRule(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;


    /**
     * 批量数据对象转换为显示对象
     * @param codeResembleRuleDOs 数据对象列表
     * @return 显示对象
     * @throws VciBaseException 参数为空或者不存在的时候会抛出异常
     */
    List<CodeResembleRuleVO> codeResembleRuleDO2VOs(Collection<CodeResembleRuleDO>  codeResembleRuleDOs) throws VciBaseException;

    /**
     * 数据对象转换为显示对象
     * @param  codeResembleRuleDO 数据对象
     * @return 显示对象
     * @throws VciBaseException 拷贝属性出错的时候会抛出异常
     */
    CodeResembleRuleVO codeResembleRuleDO2VO(CodeResembleRuleDO codeResembleRuleDO) throws VciBaseException;

    /**
     * 增加相似查询规则
     * @param codeResembleRuleDTO 相似查询规则数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeResembleRuleVO addSave(CodeResembleRuleDTO codeResembleRuleDTO) throws VciBaseException;

    /**
     * 修改相似查询规则
     * @param codeResembleRuleDTO 相似查询规则数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeResembleRuleVO editSave(CodeResembleRuleDTO codeResembleRuleDTO) throws VciBaseException;


    /**
     * 删除相似查询规则
     * @param codeResembleRuleDTO 相似查询规则数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteCodeResembleRule(CodeResembleRuleDTO codeResembleRuleDTO) throws VciBaseException;

    /**
    * 主键获取相似查询规则
    * @param oid 主键
    * @return 相似查询规则显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    CodeResembleRuleVO getObjectByOid(String oid) throws VciBaseException;

    /**
     * 主键批量获取相似查询规则
     * @param oidCollections 主键集合，但是受性能影响，建议一次查询不超过10000个
     * @return 相似查询规则显示对象
     * @throws VciBaseException 查询出现异常时会抛出
     */
    Collection<CodeResembleRuleVO> listCodeResembleRuleByOids(Collection<String> oidCollections) throws VciBaseException;



    /**
     * 参照相似查询规则列表
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 相似查询规则显示对象列表，生效的内容
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
     DataGrid<CodeResembleRuleVO> refDataGridCodeResembleRule(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;
}