package com.vci.web.service;

import com.vci.dto.VciFileVolumeDTO;
import com.vci.pagemodel.VciFileVolumeVO;
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 com.vci.model.VciFileVolumeDO;

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

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

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

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

    /**
     * 增加文仓管理
     * @param vciFileVolumeDTO 文仓管理数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    VciFileVolumeVO addSave(VciFileVolumeDTO vciFileVolumeDTO) throws VciBaseException;

    /**
     * 修改文仓管理
     * @param vciFileVolumeDTO 文仓管理数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    VciFileVolumeVO editSave(VciFileVolumeDTO vciFileVolumeDTO) throws VciBaseException;


    /**
     * 删除文仓管理
     * @param vciFileVolumeDTO 文仓管理数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteVciFileVolume(VciFileVolumeDTO vciFileVolumeDTO) throws VciBaseException;

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

    /**
     * 编号获取文仓管理
     * @param id 编号
     * @return 文仓管理显示对象
     * @throws VciBaseException 参数为空，数据不存在时会抛出异常
     */
    VciFileVolumeVO getObjectById(String id)  throws VciBaseException;

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

    /**
     * 启用文仓管理
     * @param vciFileVolumeDTO 文仓管理数据传输对象，oid和ts需要传输
     * @return 启用结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 执行出现异常时会抛出
     */
    BaseResult enableVciFileVolume(VciFileVolumeDTO vciFileVolumeDTO) throws VciBaseException;

    /**
     * 停用{comments}
     * @param vciFileVolumeDTO 文仓管理数据传输对象，oid和ts需要传输
     * @return 停用结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 执行出现异常时会抛出
     */
    BaseResult disableVciFileVolume(VciFileVolumeDTO vciFileVolumeDTO) throws VciBaseException;


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

    /**
     * 查询全部
     * @return 文仓
     * @throws VciBaseException 查询会抛出异常
     */
     List<VciFileVolumeDO> selectAll() throws VciBaseException;

    /**
     * 更新卷的使用容量
     * @param oid 主键
     * @param usedVolume 使用容量
     * @return 受影响的行数
     */
     int updateUsedVolume(String oid,  long usedVolume);

    /**
     * 获取上传的默认卷
     * @return 卷对象
     */
    VciFileVolumeDO getUploadVolume();
}