package com.tourism.webadmin.back.service;

import com.alibaba.fastjson.JSONObject;
import com.tourism.webadmin.back.model.*;
import com.tourism.common.core.object.CallResult;
import com.tourism.common.core.base.service.IBaseService;

import java.util.*;

/**
 * 旅游项目管理数据操作服务接口。
 *
 * @author 吃饭睡觉
 * @date 2024-09-06
 */
public interface TourismProjectService extends IBaseService<TourismProject, String> {

    /**
     * 保存新增对象。
     *
     * @param tourismProject 新增对象。
     * @return 返回新增对象。
     */
    TourismProject saveNew(TourismProject tourismProject);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。
     *
     * @param tourismProjectList 新增对象列表。
     */
    void saveNewBatch(List<TourismProject> tourismProjectList);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。通常适用于更大的插入数据量，如批量导入。
     *
     * @param tourismProjectList 新增对象列表。
     * @param batchSize  每批插入的数量。如果该值小于等于0，则使用缺省值10000。
     */
    void saveNewBatch(List<TourismProject> tourismProjectList, int batchSize);

    /**
     * 保存新增主表对象及关联对象。
     *
     * @param tourismProject 新增主表对象。
     * @param relationData 全部关联从表数据。
     * @return 返回新增主表对象。
     */
    TourismProject saveNewWithRelation(TourismProject tourismProject, JSONObject relationData) throws Exception;

    /**
     * 更新数据对象。
     *
     * @param tourismProject         更新的对象。
     * @param originalTourismProject 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(TourismProject tourismProject, TourismProject originalTourismProject);

    /**
     * 更新主表对象及关联对象。
     *
     * @param tourismProject 主表对象新数据。
     * @param originalTourismProject 主表对象源数据。
     * @param relationData 全部关联从表数据。
     * @return 修改成功返回true，否则false。
     */
    boolean updateWithRelation(TourismProject tourismProject, TourismProject originalTourismProject, JSONObject relationData) throws Exception;

    /**
     * 删除指定数据。
     *
     * @param id 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(String id);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getTourismProjectListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<TourismProject> getTourismProjectList(TourismProject filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getTourismProjectList)，以便获取更好的查询性能。
     *
     * @param filter 主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<TourismProject> getTourismProjectListWithRelation(TourismProject filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回不与指定主表主键Id存在对多对关系的列表。
     *
     * @param travelNotesId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<TourismProject> getNotInTourismProjectListByTravelNotesId(String travelNotesId, TourismProject filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id存在对多对关系的列表。
     *
     * @param travelNotesId 主表主键Id。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<TourismProject> getTourismProjectListByTravelNotesId(String travelNotesId, TourismProject filter, String orderBy);

    /**
     * 在多对多关系中，当前Service的数据表为从表，返回与指定主表主键Id列表存在对多对关系的列表。
     *
     * @param tourTourismProjectTravelNotesList 主表对象集合。
     * @param filter 从表的过滤对象。
     * @param orderBy 排序参数。
     * @return key是主表的主键Id，value是多对多从表的对象列表。
     */
    Map<String, List<TourismProject>> getTourismProjectListMapByTourTourismProjectTravelNotesList(
            List<TourTourismProjectTravelNotes> tourTourismProjectTravelNotesList, TourismProject filter, String orderBy);

    /**
     * 对批量导入数据列表进行数据合法性验证。
     * 验证逻辑主要覆盖主表的常量字典字段、字典表字典字段、数据源字段和一对一关联数据是否存在。
     *
     * @param dataList 主表的数据列表。
     * @param ignoreFieldSet 需要忽略校验的字典字段集合。通常对于字典反向翻译过来的字段适用，
     *                       避免了二次验证，以提升效率。
     * @return 验证结果。如果失败，包含具体的错误信息和导致错误的数据对象。
     */
    CallResult verifyImportList(List<TourismProject> dataList, Set<String> ignoreFieldSet);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getDirectoryInfoListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<DirectoryInfo> getDirectoryInfoList(DirectoryInfo filter, String orderBy);
}
