package org.springblade.code.service;


import com.vci.mdm.dto.CodeFixedValueDTO;
import com.vci.mdm.model.CodeFixedValueDO;
import com.vci.mdm.pagemodel.CodeFixedValueVO;
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-01-24
 */
public interface CodeFixedValueServiceI {
    /**
     * 查询所有的固定码段的码值
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 执行结果
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<CodeFixedValueVO> gridCodeFixedValue(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;


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

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

    /**
     * 增加固定码段的码值
     * @param codeFixedValueDTO 固定码段的码值数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeFixedValueVO addSave(CodeFixedValueDTO codeFixedValueDTO) throws VciBaseException;

    /**
     * 修改固定码段的码值
     * @param codeFixedValueDTO 固定码段的码值数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeFixedValueVO editSave(CodeFixedValueDTO codeFixedValueDTO) throws VciBaseException;


    /**
     * 删除固定码段的码值
     * @param codeFixedValueDTO 固定码段的码值数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteCodeFixedValue(CodeFixedValueDTO codeFixedValueDTO) throws VciBaseException;

    /**
    * 主键获取固定码段的码值
    * @param oid 主键
    * @return 固定码段的码值显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    CodeFixedValueVO getObjectByOid(String oid) throws VciBaseException;

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



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

    /**
     * 使用码段的主键获取固定码的码值
     * @param secOidCollection 码段的主键
     * @return 码值显示对象
     * @throws VciBaseException 查询的时候出现了错误会抛出异常
     */
    Map<String,List<CodeFixedValueVO>> listCodeFixedValueBySecOids(Collection<String> secOidCollection) throws VciBaseException;

    /**
     * 批量添加固定码段的码值，如果保存的集合中不存在已在数据库中的码值则删除。主要是保存码值的序号
     * @param dtoList 固定码段的码值列表
     * @param codefixedsecoid 固定码段的主键
     * @return 执行结果
     */
    BaseResult<CodeFixedValueVO> batchSave4Order(List<CodeFixedValueDTO> dtoList, String codefixedsecoid);

    /**
     * 根据码段主键删除其存在的码值对象
     * @param codefixedsecoid 固定码段的主键
     * @return 执行结果
     */
    BaseResult<CodeFixedValueVO> batchDeleteBySecOid(String codefixedsecoid);
}