package com.tourism.webadmin.back.service;

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

import java.util.*;

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

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

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

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

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

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

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

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

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

    /**
     * 批量添加多对多关联关系。
     *
     * @param tourTravelNotesProjectRelationList 多对多关联表对象集合。
     * @param travelNotesId 主表Id。
     */
    void addTourTravelNotesProjectRelationList(List<TourTravelNotesProjectRelation> tourTravelNotesProjectRelationList, String travelNotesId);

    /**
     * 更新中间表数据。
     *
     * @param tourTravelNotesProjectRelation 中间表对象。
     * @return 更新成功与否。
     */
    boolean updateTourTravelNotesProjectRelation(TourTravelNotesProjectRelation tourTravelNotesProjectRelation);

    /**
     * 获取中间表数据。
     *
     * @param travelNotesId 主表Id。
     * @param projectId 从表Id。
     * @return 中间表对象。
     */
    TourTravelNotesProjectRelation getTourTravelNotesProjectRelation(String travelNotesId, String projectId);

    /**
     * 移除单条多对多关系。
     *
     * @param travelNotesId 主表Id。
     * @param projectId 从表Id。
     * @return 成功返回true，否则false。
     */
    boolean removeTourTravelNotesProjectRelation(String travelNotesId, String projectId);

    /**
     * 批量移除单条多对多关系。
     *
     * @param travelNotesId 主表Id。
     * @param projectIdList 从表Id列表。
     * @return 成功返回true，否则false。
     */
    void removeTourTravelNotesProjectRelationList(String travelNotesId, List<String> projectIdList);
}
