package com.vci.ubcs.code.service;

import com.vci.ubcs.code.entity.CodeClassifyTemplateAttrDO;
import com.vci.ubcs.code.entity.CodeTemplatePhaseDO;
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.web.pageModel.BatchCBO;
import com.vci.ubcs.code.dto.CodeTemplatePhaseDTO;
import com.vci.ubcs.code.vo.pagemodel.CodeClassifyTemplateAttrVO;
import com.vci.ubcs.code.vo.pagemodel.CodeTemplatePhaseVO;

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

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


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

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

    /**
     * 增加模板阶段
     * @param codeTemplatePhaseDTO 模板阶段数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeTemplatePhaseVO addSave(CodeTemplatePhaseDTO codeTemplatePhaseDTO) throws VciBaseException;

    /**
     * 修改模板阶段
     * @param codeTemplatePhaseDTO 模板阶段数据传输对象
     * @return 执行结果
     * @throws VciBaseException 参数为空，唯一项，必输项不通过时会抛出异常
     */
    CodeTemplatePhaseVO editSave(CodeTemplatePhaseDTO codeTemplatePhaseDTO) throws VciBaseException;

    /**
     * 删除模板阶段
     * @param codeTemplatePhaseDTO 模板阶段数据传输对象，oid和ts需要传输
     * @return 删除结果反馈：：success：成功，fail：失败
     * @throws VciBaseException 参数为空，被引用时抛出异常
     */
    BaseResult deleteCodeTemplatePhase(CodeTemplatePhaseDTO codeTemplatePhaseDTO) throws VciBaseException;

    /**
     * 模板修改触发功能
     * @param attrDOList 属性的数据对象
     * @return 受影响的数据
     */
    BatchCBO codeTemplateAttrModifyTrigger(List<CodeClassifyTemplateAttrDO> attrDOList);

    /**
     * 模板属性删除的时候触发
     * @param attrDOList 属性的数据对象
     * @return 受影响的数据
     */
    BatchCBO codeTemplateAttrDeleteTrigger(List<CodeClassifyTemplateAttrDO> attrDOList);

    /**
     * 模板删除的时候触发
     * @param classifyTemplateOid 模板的主键
     * @return 受影响的数据
     */
    BatchCBO codeTemplateDeleteTrigger(String classifyTemplateOid);

    /**
    * 主键获取模板阶段
    * @param oid 主键
    * @return 模板阶段显示对象
    * @throws VciBaseException 参数为空，数据不存在时会抛出异常
    */
    CodeTemplatePhaseVO getObjectByOid(String oid) throws VciBaseException;

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

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

    /**
     * 阶段不包含的属性
     * @param conditionMap 查询对象，必须要有模板的主键（classifyTemplateOid），否则不能确定属性
     * @param pageHelper 分页对象
     * @return 属性的信息
     */
    DataGrid<CodeClassifyTemplateAttrVO> gridUnUsedAttribute(Map<String, String> conditionMap, PageHelper pageHelper);

    /**
     * 阶段包含的属性
     * @param conditionMap 查询对象，必须要阶段的主键(codePhaseOid)
     * @param pageHelper 分页对象
     * @return 属性的信息
     */
    DataGrid<CodeClassifyTemplateAttrVO> gridUsedAttribute(Map<String, String> conditionMap, PageHelper pageHelper);
}