/*
 *      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.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.vci.ubcs.code.dto.CodeRuleDTO;
import com.vci.ubcs.code.entity.CodeRule;
import com.vci.ubcs.code.vo.pagemodel.CodeClassifyVO;
import com.vci.ubcs.code.vo.pagemodel.CodeRuleVO;
import com.vci.ubcs.starter.exception.VciBaseException;
import com.vci.ubcs.starter.web.pagemodel.BladeQueryObject;
import org.springblade.core.mp.support.Query;
import org.springblade.core.tool.api.R;

import java.rmi.ServerException;
import java.util.Collection;
import java.util.Map;

/**
 * 编码规则 服务类
 *
 * @author ludc
 * @since 2023-04-03
 */
public interface ICodeRuleService extends IService<CodeRule> {

	/**
	 * 自定义分页
	 *
	 * @param query
	 * @param condtionMap
	 * @return
	 */
	IPage<CodeRuleVO> gridCodeRule(Query query, Map<String,Object> condtionMap) throws VciBaseException;

	/**
	 * 检查id编号是否重复
	 * @param codeRuleDTO 当前判断是否重复的对象
	 * @return 返回false表示未重复
	 */
	boolean checkCodeRuleRepeat(CodeRuleDTO codeRuleDTO);

	/**
	 * 校验编码规则的状态是否可以编辑或删除
	 * @param lcStatus 编码规则
	 * @return true表示可以编辑或删除，false表示不可以
	 */
	boolean checkEditDelStatus(String lcStatus) throws VciBaseException;

	/**
	 * 增加主数据编码规则
	 * @param codeRuleDTO 主数据编码规则数据传输对象
	 * @return 执行结果
	 */
	R addSave(CodeRuleDTO codeRuleDTO) throws VciBaseException;

	/**
	 * 修改主数据编码规则
	 * @param codeRuleDTO 主数据编码规则数据传输对象
	 * @return 执行结果
	 */
	R editSave(CodeRuleDTO codeRuleDTO) throws VciBaseException;

	/**
	 * 删除主数据编码规则
	 * @param codeRuleDTO 主数据编码规则数据传输对象，oid和ts需要传输
	 * @return 删除结果反馈：：success：成功，fail：失败
	 * @throws VciBaseException 参数为空，被引用时抛出异常
	 */
	R deleteCodeRule(CodeRuleDTO codeRuleDTO) throws VciBaseException;

	/**
	 * 检验编码规则是否已经被使用
	 * @param oid 编码规则主键
	 * @return true表示已经使用，false表示未被使用
	 */
	boolean isAlreadyInUse(String oid) throws VciBaseException;

	/**
	 * 查看主数据编码规则的使用范围
	 * @param oid 编码规则主键
	 * @return 主题库分类使用到该编码规则的所有集合
	 */
	Collection<CodeClassifyVO> listUseRangeInCodeClassify(String oid) throws VciBaseException;

	/**
	 * 主键获取主数据编码规则
	 * @param oid 主键
	 * @return 主数据编码规则显示对象
	 * @throws VciBaseException 参数为空，数据不存在时会抛出异常
	 */
	CodeRuleVO getObjectByOid(String oid) throws VciBaseException;

	/**
	 * 主键批量获取主数据编码规则
	 * @param oidCollections 主键集合，但是受性能影响，建议一次查询不超过10000个
	 * @return 主数据编码规则显示对象
	 * @throws VciBaseException 查询出现异常时会抛出
	 */
	Collection<CodeRuleVO> listCodeRuleByOids(Collection<String> oidCollections) throws VciBaseException;

	/**
	 * 主键批量获取主数据编码规则
	 *
	 * @param oidCollections 主键集合，但是受性能影响，建议一次查询不超过10000个
	 * @param hasSec         是否包含码段
	 * @return 主数据编码规则显示对象
	 * @throws VciBaseException 查询出现异常时会抛出
	 */
	Collection<CodeRuleVO> listCodeRuleByIds(Collection<String> oidCollections,boolean hasSec)throws VciBaseException ;

	/**
	 * 参照主数据编码规则列表
	 * @param bladeQueryObject 查询条件
	 * @return 主数据编码规则显示对象列表，生效的内容
	 * @throws VciBaseException 查询条件和分页出错的时候会抛出异常
	 */
	IPage<CodeRuleVO> refDataGridCodeRule(BladeQueryObject bladeQueryObject) throws VciBaseException;

	/**
	 * 停用与启用编码规则
	 * @param oid 编码规则主键
	 * @param update enable:启用 disable:停用 release:发布
	 * @return 执行结果
	 */
	R updateStatus(String oid, String update) throws VciBaseException;

	/**
	 * 克隆编码规则
	 * @param codeRuleDTO 主数据编码规则数据传输对象，oid和ts需要传输
	 * @return 主数据编码规则显示对象
	 */
	R cloneCodeRule(CodeRuleDTO codeRuleDTO) throws ServerException;

	/**
	 * 编码规则清空所有已生成的编码
	 * @param oid 编码规则主键
	 * @return 执行结果
	 */
	R clearAllCode(String oid) throws VciBaseException;

	/**
	 * 使用主键获取编码规则的内容
	 * @param codeRuleOid 主键
	 * @return 规则的显示对象
	 */
	CodeRuleVO getObjectHasSecByOid(String codeRuleOid) throws VciBaseException;

	/**
	 * 检查相似编码规则，并返回对应的结果
	 * @param oid 主键
	 * @return 执行结果
	 */
	R checkLikeCodeRule(String oid) throws VciBaseException;

}