package com.yice.webadmin.app.service;

import com.yice.common.core.base.service.IBaseService;
import com.yice.webadmin.app.model.KnowledgeManage;
import com.yice.webadmin.app.model.KnowledgeUser;
import com.yice.webadmin.upms.model.SysUser;

import java.util.List;

/**
 * 知识库管理数据操作服务接口。
 *
 * @author linking
 * @date 2023-04-13
 */
public interface KnowledgeManageService extends IBaseService<KnowledgeManage, Long> {

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

    /**
     * 批量新增用户页面关联。
     *
     * @param knowledgeUserList 用户页面关系数据列表。
     */
    void addKnowledgeUserList(List<KnowledgeUser> knowledgeUserList);

    /**
     * 移除指定用户和指定知识库的关联关系。
     *
     * @param knowledgeId 知识库标识。
     * @param userId 用户主键Id。
     * @return 移除成功返回true，否则false。
     */
    boolean removeKnowledgeUser(Long knowledgeId, Long userId);

    /**
     * 获取指定角色的用户列表。
     *
     * @param knowledgeId 知识库标识。
     * @param filter  用户过滤对象。
     * @param orderBy 排序参数。
     * @return 用户列表。
     */
    List<SysUser> getSysUserListByKnowledgeId(Long knowledgeId, SysUser filter, String orderBy);

    /**
     * 获取不属于指定知识库的用户列表。
     *
     * @param knowledgeId 知识库ID。
     * @param filter  用户过滤对象。
     * @param orderBy 排序参数。
     * @return 用户列表。
     */
    List<SysUser> getNotInSysUserListByKnowledgeId(Long knowledgeId, SysUser filter, String orderBy);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<KnowledgeManage> loadKnowledgeUserList(KnowledgeManage filter, String orderBy);

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

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

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

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

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