package com.vci.frameworkcore.compatibility;

import com.vci.pagemodel.OrgDutyVO;
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 OrgDutyQueryServiceI {
    /**
     * 根据职务主键获取职务的信息
     * @param dutyOid 职务主键
     * @return 职务的显示对象，如果职务不存在则返回null，不会抛出异常
     * @throws VciBaseException 参数为空或者数据库存在问题的时候会抛出异常
     */
    OrgDutyVO getDutyByDutyOid(String dutyOid) throws VciBaseException;

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

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

    /**
     * 根据职务主键获取职务的姓名
     * @param dutyOid 职务主键
     * @return 职务姓名，如果不存在会返回null
     */
    String getDutyNameByDutyOid(String dutyOid);

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

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

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

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

    /**
     * 参照职务的列表，默认会以职务名称升序排列，只显示启用的职务
     * @param queryMap 查询条件
     * @param pageHelper 分页和排序的信息，在兼容老平台的时候会自动兼容，如果属性不存在会自动忽略
     * @return 职务的显示对象列表
     * @throws VciBaseException 参数为空的时候会抛出异常
     */
    DataGrid<OrgDutyVO> refGridDutys(Map<String, String> queryMap, PageHelper pageHelper) throws VciBaseException;

    /**
     * 职务的参照树
     * @param treeQueryObject 树形的查询对象
     * @return 职务树，会包含职务的所有属性
     * @throws VciBaseException
     */
    List<Tree> refTreeDutys(TreeQueryObject treeQueryObject) throws VciBaseException;
    
}