package com.vci.web.service;
import com.vci.starter.web.exception.VciBaseException;
import com.vci.starter.web.pagemodel.DataGrid;
import com.vci.starter.web.pagemodel.PageHelper;
import com.vci.dto.OsCodeGenSchemaDTO;
import com.vci.model.OsCodeGenSchemaDO;
import com.vci.pagemodel.OsCodeGenSchemaVO;

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

/**
 * 代码生成方案服务
 * @author weidy
 */
public interface OsCodeGenSchemaServiceI {

    /**
     * 代码生成方案列表
     * @param conditionMap 查询条件
     * @param pageHelper 分页对象
     * @return 方案的显示对象
     * @throws VciBaseException  执行出错可能会抛出异常
     */
    DataGrid<OsCodeGenSchemaVO> gridSchema(Map<String, String> conditionMap, PageHelper pageHelper) throws VciBaseException;

    /**
     * 数据对象列表转为显示对象列表
     * @param schemaDOList 数据对象列表
     * @return 显示对象列表
     */
    List<OsCodeGenSchemaVO> codeGenSchemaDO2VOs(List<OsCodeGenSchemaDO> schemaDOList);

    /**
     * 数据对象转换为显示对象
     * @param schemaDO 数据对象
     * @return 显示对象
     */
    OsCodeGenSchemaVO codeGenSchemaDO2VO(OsCodeGenSchemaDO schemaDO);

    /**
     * 添加代码生成方案
     * @param codeGenSchemaDTO 方案数据传输对象
     * @return 方案显示对象
     * @throws VciBaseException 参数为空或者执行出错的时候会抛出异常
     */
    OsCodeGenSchemaVO addSchema(OsCodeGenSchemaDTO codeGenSchemaDTO) throws VciBaseException;

    /**
     * 修改代码生成方案
     * @param codeGenSchemaDTO 方案数据传输对象
     * @return 方案显示对象
     * @throws VciBaseException 参数为空或者执行出错的时候会抛出异常
     */
    OsCodeGenSchemaVO editSchema(OsCodeGenSchemaDTO codeGenSchemaDTO) throws VciBaseException;

    /**
     * 生成代码文件
     * @param oid 方案的主键
     * @throws VciBaseException 参数为空，方案不存在会抛出异常
     */
    void productCodeFile(String oid) throws VciBaseException;

    /**
     * 预览代码文件
     * @param oid 方案的主键
     * @return key是文件类别，value是文件的内容
     * @throws VciBaseException 参数为空，方案不存在会抛出异常
     */
    Map<String,String> previewCodeFile(String oid) throws VciBaseException;

    /**
     * 下载代码文件
     * @param oid 方案的主键
     * @return zip文件的路径
     * @throws VciBaseException 参数为空，方案不存在会抛出异常
     */
    String downloadCodeFile(String oid) throws VciBaseException;

    /**
     * 根据主键获取显示对象
     * @param oid 主键
     * @return 方案的显示对象
     * @throws VciBaseException 参数为空，方案不存在会抛出异常
     */
    OsCodeGenSchemaVO getObjectByOid(String oid) throws VciBaseException;
}