程序包 net.risesoft.api.platform.org

接口 DepartmentApi

  • @Validated
public interface DepartmentApi
    部门服务组件
    从以下版本开始:
    9.6.0
    作者:
    dingzhaojun, qinman, mengjuhua
    Date:
    2022/2/10

    • 方法概要

      所有方法 实例方法 抽象方法 
      修饰符和类型 方法 说明
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Department> create​(@NotBlank String tenantId, CreateDepartmentDTO department)
      新建部门
      net.risesoft.pojo.Y9Result<Object> delete​(@NotBlank String tenantId, @NotBlank String departmentId)
      删除部门
      net.risesoft.pojo.Y9Result<Object> disable​(@NotBlank String tenantId, @NotBlank String departmentId)
      禁用部门
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Department> get​(@NotBlank String tenantId, @NotBlank String departmentId)
      根据id获得部门对象
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listBureauByNameLike​(@NotBlank String tenantId, String name)
      模糊查询委办局列表
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByIds​(@NotBlank String tenantId, @NotEmpty List<String> ids)
      根据id列表获得部门对象列表
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByName​(@NotBlank String tenantId, @NotBlank String name)
      根据部门名称模糊查询部门列表（不包含禁用）
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByParentId​(@NotBlank String tenantId, @NotBlank String parentId)
      获取下一级部门列表（不包含禁用）
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.DepartmentProp>> listDepartmentPropByOrgUnitIdAndCategory​(@NotBlank String tenantId, @NotBlank String orgUnitId, net.risesoft.enums.platform.DepartmentPropCategoryEnum category)
      根据组织节点id查找管理的部门部门属性配置
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.OrgUnit>> listDepartmentPropOrgUnits​(@NotBlank String tenantId, @NotBlank String departmentId, Integer category)
      获取部门属性对应组织节点列表
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listRecursivelyByParentId​(@NotBlank String tenantId, @NotBlank String parentId)
      递归获得所有层级子部门列表（不包含禁用）

    • 方法详细资料

      • create

        @PostMapping("/create")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Department> create​(@RequestParam("tenantId") @NotBlank
                                                                          @NotBlank String tenantId,
                                                                          @Validated @RequestBody
                                                                          CreateDepartmentDTO department)
        新建部门
        参数:
        tenantId - 租户id
        department - 部门对象
        返回:
        Y9Result<Department> 通用请求返回对象 - data 是保存的部门
        从以下版本开始:
        9.6.0

      • delete

        @PostMapping("/delete")
net.risesoft.pojo.Y9Result<Object> delete​(@RequestParam("tenantId") @NotBlank
                                          @NotBlank String tenantId,
                                          @RequestParam("departmentId") @NotBlank
                                          @NotBlank String departmentId)
        删除部门
        参数:
        tenantId - 租户id
        departmentId - 部门id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.0

      • disable

        @PostMapping("/disable")
net.risesoft.pojo.Y9Result<Object> disable​(@RequestParam("tenantId") @NotBlank
                                           @NotBlank String tenantId,
                                           @RequestParam("departmentId") @NotBlank
                                           @NotBlank String departmentId)
        禁用部门
        参数:
        tenantId - 租户id
        departmentId - 部门id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.0

      • get

        @GetMapping("/get")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Department> get​(@RequestParam("tenantId") @NotBlank
                                                                       @NotBlank String tenantId,
                                                                       @RequestParam("departmentId") @NotBlank
                                                                       @NotBlank String departmentId)
        根据id获得部门对象
        参数:
        tenantId - 租户id
        departmentId - 部门唯一标识
        返回:
        Y9Result<Department> 通用请求返回对象 - data 是部门对象
        从以下版本开始:
        9.6.0

      • listBureauByNameLike

        @GetMapping("/listBureauByNameLike")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listBureauByNameLike​(@RequestParam("tenantId") @NotBlank
                                                                                              @NotBlank String tenantId,
                                                                                              @RequestParam(name="name",required=false)
                                                                                              String name)
        模糊查询委办局列表
        参数:
        tenantId - 租户id
        name - 委办局名称
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是委办局集合
        从以下版本开始:
        9.6.6

      • listByIds

        @GetMapping("/listByIds")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByIds​(@RequestParam("tenantId") @NotBlank
                                                                                   @NotBlank String tenantId,
                                                                                   @RequestParam("ids") @NotEmpty
                                                                                   @NotEmpty List<String> ids)
        根据id列表获得部门对象列表
        参数:
        tenantId - 租户id
        ids - 部门唯一标识结合
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是部门对象集合
        从以下版本开始:
        9.6.0

      • listByName

        @GetMapping("/listByName")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByName​(@RequestParam("tenantId") @NotBlank
                                                                                    @NotBlank String tenantId,
                                                                                    @RequestParam("name") @NotBlank
                                                                                    @NotBlank String name)
        根据部门名称模糊查询部门列表（不包含禁用）
        参数:
        tenantId - 租户id
        name - 部门名称
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是部门列表
        从以下版本开始:
        9.6.0

      • listByParentId

        @GetMapping("/listByParentId")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listByParentId​(@RequestParam("tenantId") @NotBlank
                                                                                        @NotBlank String tenantId,
                                                                                        @RequestParam("parentId") @NotBlank
                                                                                        @NotBlank String parentId)
        获取下一级部门列表（不包含禁用）
        参数:
        tenantId - 租户id
        parentId - 部门唯一标识
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是部门对象集合
        从以下版本开始:
        9.6.0

      • listDepartmentPropByOrgUnitIdAndCategory

        @GetMapping("/listDepartmentPropByOrgUnitIdAndCategory")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.DepartmentProp>> listDepartmentPropByOrgUnitIdAndCategory​(@RequestParam("tenantId") @NotBlank
                                                                                                                      @NotBlank String tenantId,
                                                                                                                      @RequestParam("orgUnitId") @NotBlank
                                                                                                                      @NotBlank String orgUnitId,
                                                                                                                      @RequestParam("category")
                                                                                                                      net.risesoft.enums.platform.DepartmentPropCategoryEnum category)
        根据组织节点id查找管理的部门部门属性配置
        参数:
        tenantId - 租户id
        orgUnitId - 组织节点id
        category - 配置类型 DepartmentPropCategoryEnum
        返回:
        Y9Result<List<DepartmentProp>> 通用请求返回对象 - data 是部门属性配置集合
        从以下版本开始:
        9.6.0

      • listDepartmentPropOrgUnits

        @GetMapping("/listDepartmentPropOrgUnits")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.OrgUnit>> listDepartmentPropOrgUnits​(@RequestParam("tenantId") @NotBlank
                                                                                                 @NotBlank String tenantId,
                                                                                                 @RequestParam("departmentId") @NotBlank
                                                                                                 @NotBlank String departmentId,
                                                                                                 @RequestParam
                                                                                                 Integer category)
        获取部门属性对应组织节点列表
        参数:
        tenantId - 租户id
        departmentId - 部门唯一标识
        category - 部门属性类型
        返回:
        Y9Result<List<OrgUnit>> 通用请求返回对象 - data 是人员或岗位对象集合
        从以下版本开始:
        9.6.0

      • listRecursivelyByParentId

        @GetMapping("/listRecursivelyByParentId")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listRecursivelyByParentId​(@RequestParam("tenantId") @NotBlank
                                                                                                   @NotBlank String tenantId,
                                                                                                   @RequestParam("parentId") @NotBlank
                                                                                                   @NotBlank String parentId)
        递归获得所有层级子部门列表（不包含禁用）
        参数:
        tenantId - 租户id
        parentId - 组织节点唯一标识(可能是机构ID,也可能是部门ID)
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是部门对象集合
        从以下版本开始:
        9.6.0