package com.tourism.webadmin.back.service;

import com.alibaba.fastjson.JSONObject;
import com.tourism.webadmin.app.website.model.TourShortImGroup;
import com.tourism.webadmin.app.website.vo.TourShortImGroupVo;
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 TourImGroupService extends IBaseService<TourImGroup, Long> {

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

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

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

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

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

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

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

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

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

    /**
     * 判断从表数据是否存在，如果存在就不能删除主对象，否则可以删除主对象。
     * 适用于主表对从表不是强制级联删除的场景。
     *
     * @param tourImGroup 主表对象。
     * @return 没有关联数据返回true，否则false，同时返回具体的提示信息。
     */
    CallResult verifyRelatedDataBeforeDelete(TourImGroup tourImGroup);

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

    /**
     * 获取自己参与的群聊列表
     *
     * @param userId  用户id。
     * @return 查询结果集。
     */
    List<TourShortImGroup> getTakePartImGroupListByName(Long userId,String name);
}
