package com.vci.frameworkcore.compatibility;

import com.vci.frameworkcore.pagemodel.OrgDepartmentVO;
import com.vci.starter.web.exception.VciBaseException;
import com.vci.starter.web.pagemodel.DataGrid;
import com.vci.starter.web.pagemodel.PageHelper;
import com.vci.starter.web.pagemodel.Tree;
import com.vci.starter.web.pagemodel.TreeQueryObject;

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

/**
 * 部门的查询服务，兼容老平台
 * @author weidy
 * @date 2020/3/1
 */
public interface OrgDeptQueryServiceI {

    /**
     * 根据部门主键获取部门的信息
     * @param deptOid 部门主键
     * @return 部门的显示对象，如果部门不存在则返回null，不会抛出异常
     * @throws VciBaseException 参数为空或者数据库存在问题的时候会抛出异常
     */
    OrgDepartmentVO getDeptByDeptOid(String deptOid) throws VciBaseException;

    /**
     * 批量获取部门的信息 （根据部门主键）
     * @param deptOidCollections 部门主键的集合，可以超过1000个
     * @return 部门的显示对象，如果部门不存在则返回空的列表，不会抛出异常
     * @throws VciBaseException 参数为空或者数据库存在问题的时候会抛出异常
     */
    List<OrgDepartmentVO> listDeptByDeptOids(Collection<String> deptOidCollections) throws VciBaseException;

    /**
     * 获取部门的列表，默认会以部门名称升序排列，部门的编辑页面列表不要使用这个接口
     * @param queryMap 查询条件
     * @param pageHelper 分页和排序的信息，在兼容老平台的时候会自动兼容，如果属性不存在会自动忽略
     * @return 部门的显示对象列表
     * @throws VciBaseException 参数为空的时候会抛出异常
     */
    DataGrid<OrgDepartmentVO> gridDepts(Map<String, String> queryMap, PageHelper pageHelper) throws VciBaseException;

    /**
     * 根据部门主键获取部门的姓名
     * @param deptOid 部门主键
     * @return 部门姓名，如果不存在会返回null
     */
    String getDeptNameByDeptOid(String deptOid);

    /**
     * 根据用户主键获取关联的部门
     * @param userOid 用户主键
     * @param queryMap 查询条件，如果需要使用用户的属性来查询可以使用pkUser.xxxx
     * @return 部门的显示对象
     */
    OrgDepartmentVO listDeptByUserOid(String userOid, Map<String, String> queryMap);


    /**
     * 获取未关联某个用户的部门
     * @param userOid 用户主键
     * @param queryMap 查询条件，如果需要使用用户的属性来查询可以使用pkUser.xxxx
     * @return 部门的显示对象
     */
    List<OrgDepartmentVO> listDeptUnInUserOid(String userOid, Map<String, String> queryMap);

    /**
     * 获取未关联某个用户的部门
     * @param userOid 用户主键
     * @param queryMap 查询条件，如果需要使用用户的属性来查询可以使用pkUser.xxxx
     * @param pageHelper 分页和排序对象，老平台不支持使用部门编号来排序
     * @return 部门的显示对象
     */
    DataGrid<OrgDepartmentVO>  gridDeptUninUserOid(String userOid, Map<String, String> queryMap, PageHelper pageHelper);

    /**
     * 批量根据用户的主键来获取部门
     * @param userOidCollection 用户主键集合
     * @param queryMap 查询条件，如果需要使用用户的属性来查询可以使用pkUser.xxxx
     * @return 部门的显示对象，key是用户主键,value是这个用户关联的部门
     */
    Map<String,List<OrgDepartmentVO>> batchListDeptByUserOids(Collection<String> userOidCollection, Map<String, String> queryMap);

    /**
     * 获取某个部门的直属下级部门
     * @param pkFatherDepartmment 部门的主键
     * @param queryMap 查询条件
     * @return 部门显示对象
     */
    List<OrgDepartmentVO> listChildrenDeptByParentOid(String pkFatherDepartmment, Map<String, String> queryMap);

    /**
     * 获取某个部门的所有曾经的下级部门
     * @param pkFatherDepartmment 部门的主键
     * @param queryMap 查询条件
     * @return 部门显示对象
     */
    List<OrgDepartmentVO> listAllLevelChildrenDeptByParentOid(String pkFatherDepartmment, Map<String, String> queryMap);

    /**
     * 参照树形数据的部门信息
     * @param treeQueryObject 树形查询的条件
     * @return 树节点
     */
    List<Tree> refTreeDept(TreeQueryObject treeQueryObject);

    /**
     * 参照树形表格的部门信息，上级部门的是表格中的树形列
     * @param treeQueryObject 树形查询的条件
     * @return 部门的树表信息
     */
    DataGrid refTreeGridDept(TreeQueryObject treeQueryObject);

}