package com.vci.ubcs.code.service;


import com.vci.ubcs.code.entity.CodeBasicSecDO;
import com.vci.starter.web.exception.VciBaseException;
import com.vci.starter.web.pagemodel.*;
import com.vci.web.pageModel.BatchCBO;
import com.vci.ubcs.code.dto.CodeBasicSecDTO;
import com.vci.ubcs.code.vo.pagemodel.CodeBasicSecVO;

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

/**
 * 码段基础信息服务接口
 *
 * @author weidy
 * @date 2022-01-24
 */
public interface CodeBasicSecServiceI {
    /**
     * 查询所有的码段基础信息
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 执行结果
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<CodeBasicSecVO> gridCodeBasicSec(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;


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

    /**
     * 批量数据对象转换为显示对象
     *
     * @param codeBasicSecDOs 数据对象列表
     * @param hasFixedValue 是否有固定值
     * @return 显示对象
     * @throws VciBaseException 参数为空或者不存在的时候会抛出异常
     */
    List<CodeBasicSecVO> codeBasicSecDO2VOs(Collection<CodeBasicSecDO> codeBasicSecDOs, boolean hasFixedValue) throws VciBaseException;

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

    /**
     * 增加码段基础信息
     * @param codeBasicSecDTO 码段基础信息数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeBasicSecVO addSave(CodeBasicSecDTO codeBasicSecDTO) throws VciBaseException;

    /**
     * 修改码段基础信息
     * @param codeBasicSecDTO 码段基础信息数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeBasicSecVO editSave(CodeBasicSecDTO codeBasicSecDTO) throws VciBaseException;


    /**
     * 删除码段基础信息
     * @param codeBasicSecDTO 码段基础信息数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteCodeBasicSec(CodeBasicSecDTO codeBasicSecDTO) throws VciBaseException;

    /**
    * 主键获取码段基础信息
    * @param oid 主键
    * @return 码段基础信息显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    CodeBasicSecVO getObjectByOid(String oid) throws VciBaseException;

    /**
     * 主键批量获取码段基础信息
     * @param oidCollections 主键集合，但是受性能影响，建议一次查询不超过10000个
     * @return 码段基础信息显示对象
     * @throws VciBaseException 查询出现异常时会抛出
     */
    Collection<CodeBasicSecVO> listCodeBasicSecByOids(Collection<String> oidCollections) throws VciBaseException;



    /**
     * 参照码段基础信息列表
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 码段基础信息显示对象列表，生效的内容
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
     DataGrid<CodeBasicSecVO> refDataGridCodeBasicSec(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;

    /**
     * 主键删除码段基础信息
     * @param oid 码段基础信息主键
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteCodeBasicSecByPrimaryKey(String oid) throws VciBaseException;

    /**
     * 克隆码段信息
     * @param oidList 源码段信息主键集合
     * @param pkCodeRule 目标编码规则
     * @return 克隆结果反馈：：success：成功，fail：失败
     */
    BaseResult cloneCodeBasicSec(List<String> oidList, String pkCodeRule);

    /**
     * 查询目标分类码段所在的树结构
     * @param oid 目标分类码段主键
     * @return 分类码段树结构
     */
    List<Tree> gridCodeClassifySecTree(String oid);

    /**
     * 根据码段分类的类型判断属性是否是空的
     *
     * @param codeBasicSecDTO 码段基础信息数据传输对象
     * @return 有空的则传key-属性名 value-字段含义，没有空的则传 key-success value-true
     */
    KeyValue checkAttrNullableBySecType(CodeBasicSecDTO codeBasicSecDTO);

    /**
     * 使用规则的主键获取对应的码段内容
     * @param ruleOid 规则的内容
     * @return 码段的内容
     */
    List<CodeBasicSecVO> listCodeBasicSecByRuleOid(String ruleOid);

    /**
     * 使用规则的主键获取对应的码段的内容
     * @param ruleCollection 规则主键集合
     * @return 码段的内容
     */
    List<CodeBasicSecVO> listCodeBasicSecByRuleOids(Collection<String> ruleCollection);

    /**
     * 参照分类的码段
     * @param conditionMap 查询条件
     * @param pageHelper 分页的对象
     * @return 码段的内容
     */
    DataGrid<CodeBasicSecVO> refDataGridClassifySec(Map<String, String> conditionMap, PageHelper pageHelper);

    /**
     * 根据编码规则批量删除码段基本信息
     * @param codeRuleOid 编码规则主键
     * @return 执行结果
     */
    BatchCBO batchDeleteSecByCodeRuleOid(String codeRuleOid);

    /**
     * 上移
     * @param oid 主键
     */
    void upOrderNum(String oid);

    /**
     * 下移
     * @param oid 主键
     */
    void downOrderNum(String oid);
}