/*
 *      Copyright (c) 2018-2028, Chill Zhuang All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the dreamlu.net developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: Chill 庄骞 (smallchill@163.com)
 */
package com.vci.ubcs.code.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.vci.ubcs.code.dto.CodeTemplatePhaseDTO;
import com.vci.ubcs.code.entity.CodeClstempattrEntity;
import com.vci.ubcs.code.entity.CodeTempphaseEntity;
import com.vci.ubcs.code.vo.pagemodel.CodeClassifyTemplateAttrVO;
import com.vci.ubcs.code.vo.pagemodel.CodeTemplatePhaseEntityVO;
import com.vci.ubcs.starter.exception.VciBaseException;
import com.vci.ubcs.starter.web.pagemodel.DataGrid;
import com.vci.ubcs.starter.web.pagemodel.PageHelper;
import org.springblade.core.mp.support.Query;
import org.springblade.core.tool.api.R;

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

/**
 * 编码库定义-模板阶段 服务类
 *
 * @author yuxc
 * @since 2023-04-20
 */
public interface ICodeTempphaseService extends IService<CodeTempphaseEntity> {

	/**
	 * 查询所有的模板阶段
	 * @param codeTemplatePhaseVO 查询条件
	 * @param query 分页和排序
	 * @return 执行结果
	 * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
	 */
	DataGrid<CodeTemplatePhaseEntityVO> gridCodeTemplatePhase(CodeTemplatePhaseEntityVO codeTemplatePhaseVO, Query query) throws VciBaseException;

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

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

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

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

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

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

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

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

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

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

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

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

}