package com.vci.web.service;

import com.vci.dto.VciFileDocClassifyDTO;
import com.vci.dto.VciFileDocClassifyDTOList;
import com.vci.pagemodel.VciFileDocClassifyVO;
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.KeyValue;
import com.vci.starter.web.pagemodel.PageHelper;
import com.vci.model.VciFileDocClassifyDO;

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

/**
 * 文档的类型服务接口
 *
 * @author weidy
 * @date 2020-08-04
 */
public interface VciFileDocClassifyServiceI {
    /**
     * 查询所有的文档的类型
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 执行结果
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<VciFileDocClassifyVO> gridVciFileDocClassify(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;

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

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

    /**
     * 增加文档的类型
     * @param vciFileDocClassifyDTO 文档的类型数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    VciFileDocClassifyVO addSave(VciFileDocClassifyDTO vciFileDocClassifyDTO) throws VciBaseException;

    /**
     * 修改文档的类型
     * @param vciFileDocClassifyDTO 文档的类型数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    VciFileDocClassifyVO editSave(VciFileDocClassifyDTO vciFileDocClassifyDTO) throws VciBaseException;


    /**
     * 删除文档的类型
     * @param vciFileDocClassifyDTO 文档的类型数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteVciFileDocClassify(VciFileDocClassifyDTO vciFileDocClassifyDTO) throws VciBaseException;

    /**
    * 主键获取文档的类型
    * @param oid 主键
    * @return 文档的类型显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    VciFileDocClassifyVO getObjectByOid(String oid) throws VciBaseException;

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

    /**
     * 参照文档的类型列表
     * @param conditionMap 查询条件
     * @param pageHelper 分页和排序
     * @return 文档的类型显示对象列表，生效的内容
     * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
     */
    DataGrid<VciFileDocClassifyVO> refDataGridVciFileDocClassify(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;

    /**
     * 校验编号是否存在
     * @param idCollections 编号的集合
     * @return success为true表示存在，否则在data中获取不存在的内容
     */
    BaseResult checkClassifyIdsExist(Collection<String> idCollections);

    /**
     * 批量添加分类
     * @param fileDocClassifyDTOList 分类的数据传输对象
     * @return success为true表示执行成功
     */
    BaseResult batchAddSave(VciFileDocClassifyDTOList fileDocClassifyDTOList);

    /**
     * 使用编号获取对象
     * @param id 编号
     * @return 显示对象
     * @throws VciBaseException 参数为空或者执行出错的时候会抛出异常
     */
    VciFileDocClassifyVO getObjectById(String id) throws VciBaseException;

    /**
     * 使用编号批量获取类型对象
     * @param idCollection 编号集合
     * @return 显示对象
     * @throws VciBaseException 参数为空或者执行出错的时候会抛出异常
     */
    List<VciFileDocClassifyVO> listVciFileDocClassifyByIds(Collection<String> idCollection) throws VciBaseException;

    /**
     * 文件类型的下拉菜单
     * @return 下拉菜单的值
     */
    List<KeyValue> comboFileDocClassify();
}