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

接口 GroupApi

@Validated
public interface GroupApi

用户组服务组件

从以下版本开始:

9.6.0

作者:

dingzhaojun, qinman, mengjuhua

Date:

2022/2/10

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	addPerson(@NotBlank String tenantId, @NotBlank String groupId, @NotBlank String personId)	向用户组添加人员
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Group>	create(@NotBlank String tenantId, CreateGroupDTO createGroupDTO)	创建用户组
net.risesoft.pojo.Y9Result<Object>	delete(@NotBlank String tenantId, @NotBlank String groupId)	删除用户组
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Group>	get(@NotBlank String tenantId, @NotBlank String groupId)	根据id获得用户组对象
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Group>>	listByParentId(@NotBlank String tenantId, @NotBlank String parentId)	获取下一级用户组列表（不包含禁用）
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Person>>	listPersonsByGroupId(@NotBlank String tenantId, @NotBlank String groupId)	获取用户组内的人员列表（不包含禁用）
net.risesoft.pojo.Y9Result<Object>	removePerson(@NotBlank String tenantId, @NotBlank String groupId, @NotBlank String personId)	将人员移除用户组

方法详细资料

addPerson

@PostMapping("/addPerson")
net.risesoft.pojo.Y9Result<Object> addPerson(@RequestParam("tenantId") @NotBlank
                                             @NotBlank String tenantId,
                                             @RequestParam("groupId") @NotBlank
                                             @NotBlank String groupId,
                                             @RequestParam("personId") @NotBlank
                                             @NotBlank String personId)

向用户组添加人员

参数:

tenantId - 租户ID

groupId - 用户组ID

personId - 人员ID

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.0

create

@PostMapping("/create")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Group> create(@RequestParam("tenantId") @NotBlank
                                                                     @NotBlank String tenantId,
                                                                     @Validated @RequestBody
                                                                     CreateGroupDTO createGroupDTO)

创建用户组

参数:

tenantId - 租户id

createGroupDTO - 用户组对象

返回:

Y9Result<Group> 通用请求返回对象 - data 是保存的用户组

从以下版本开始:

9.6.0

delete

@PostMapping("/delete")
net.risesoft.pojo.Y9Result<Object> delete(@RequestParam("tenantId") @NotBlank
                                          @NotBlank String tenantId,
                                          @RequestParam("groupId") @NotBlank
                                          @NotBlank String groupId)

删除用户组

参数:

tenantId - 租户ID

groupId - 用户组ID

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.0

get

@GetMapping("/get")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Group> get(@RequestParam @NotBlank
                                                                  @NotBlank String tenantId,
                                                                  @RequestParam("groupId") @NotBlank
                                                                  @NotBlank String groupId)

根据id获得用户组对象

参数:

tenantId - 租户id

groupId - 用户组唯一标识

返回:

Y9Result<Group> 通用请求返回对象 - data 是用户组对象

从以下版本开始:

9.6.0

listByParentId

@GetMapping("/listByParentId")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Group>> listByParentId(@RequestParam("tenantId") @NotBlank
                                                                                   @NotBlank String tenantId,
                                                                                   @RequestParam("parentId") @NotBlank
                                                                                   @NotBlank String parentId)

获取下一级用户组列表（不包含禁用）

参数:

tenantId - 租户id

parentId - 父节点唯一标识

返回:

Y9Result<List<Group>> 通用请求返回对象 - data 是用户组对象集合

从以下版本开始:

9.6.0

listPersonsByGroupId

@GetMapping("/listPersonsByGroupId")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Person>> listPersonsByGroupId(@RequestParam("tenantId") @NotBlank
                                                                                          @NotBlank String tenantId,
                                                                                          @RequestParam("groupId") @NotBlank
                                                                                          @NotBlank String groupId)

获取用户组内的人员列表（不包含禁用）

参数:

tenantId - 租户id

groupId - 用户组唯一标识

返回:

Y9Result<List<Person>> 通用请求返回对象 - data 是人员对象集合

从以下版本开始:

9.6.0

removePerson

@PostMapping("/removePerson")
net.risesoft.pojo.Y9Result<Object> removePerson(@RequestParam("tenantId") @NotBlank
                                                @NotBlank String tenantId,
                                                @RequestParam("groupId") @NotBlank
                                                @NotBlank String groupId,
                                                @RequestParam("personId") @NotBlank
                                                @NotBlank String personId)

将人员移除用户组

参数:

tenantId - 租户ID

groupId - 用户组ID

personId - 人员ID

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.0