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

接口 CustomGroupApi

@Validated
public interface CustomGroupApi

自定义用户组组件

从以下版本开始:

9.6.0

作者:

dingzhaojun, qinman, mengjuhua

Date:

2022/2/10

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	addMember(@NotBlank String tenantId, @NotBlank String customGroupId, @NotEmpty List<String> orgUnitList)	添加组成员
net.risesoft.pojo.Y9Result<Object>	deleteAllGroup(@NotBlank String tenantId, @NotEmpty List<String> groupIds)	删除用户组
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup>	findCustomGroupByCustomId(@NotBlank String tenantId, @NotBlank String customId)	根据自定义id查找自定义用户组
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup>	findCustomGroupById(@NotBlank String tenantId, @NotBlank String personId, @NotBlank String groupId)	根据id获取用户组
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Person>>	listAllPersonByGroupId(@NotBlank String tenantId, @NotBlank String groupId)	根据id解析该自定义用户组下的人员列表
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.CustomGroup>>	listCustomGroupByPersonId(@NotBlank String tenantId, @NotBlank String personId)	根据人员id获取用户组列表
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.CustomGroupMember>>	listCustomGroupMemberByGroupId(@NotBlank String tenantId, @NotBlank String personId, @NotBlank String groupId)	根据用户组id获取用户组成员
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.CustomGroupMember>>	listCustomGroupMemberByGroupIdAndMemberType(@NotBlank String tenantId, String personId, @NotBlank String groupId, net.risesoft.enums.platform.OrgTypeEnum memberType)	根据用户组id和成员类型，获取用户组成员列表
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroup>	pageCustomGroupByPersonId(@NotBlank String tenantId, @NotBlank String personId, net.risesoft.pojo.Y9PageQuery pageQuery)	根据人员id分页获取其自定义用户组列表
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroupMember>	pageCustomGroupMemberByGroupId(@NotBlank String tenantId, @NotBlank String groupId, net.risesoft.pojo.Y9PageQuery pageQuery)	根据自定义用户组id分页获取其自定义用户组成员列表
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroupMember>	pageCustomGroupMemberByGroupIdAndMemberType(@NotBlank String tenantId, @NotBlank String groupId, net.risesoft.enums.platform.OrgTypeEnum memberType, net.risesoft.pojo.Y9PageQuery pageQuery)	根据自定义用户组id和成员类型分页获取其自定义用户组成员列表
net.risesoft.pojo.Y9Result<Object>	removeMembers(@NotBlank String tenantId, @NotEmpty List<String> memberIds)	删除组成员
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup>	saveCustomGroup(@NotBlank String tenantId, net.risesoft.model.platform.CustomGroup customGroup)	保存自定义用户组
net.risesoft.pojo.Y9Result<Object>	saveCustomGroupOrder(@NotBlank String tenantId, @NotEmpty List<String> sortIds)	保存自定义用户组排序
net.risesoft.pojo.Y9Result<Object>	saveMemberOrder(@NotBlank String tenantId, @NotEmpty List<String> memberIds)	保存自定义用户组成员排序
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup>	saveOrUpdateCustomGroup(@NotBlank String tenantId, @NotBlank String personId, @NotEmpty List<String> personIds, String groupId, @NotBlank String groupName)	保存用户组
net.risesoft.pojo.Y9Result<Object>	shareCustomGroup(@NotBlank String tenantId, @NotEmpty List<String> personIds, @NotEmpty List<String> groupIds)	分享用户组给其他人使用

方法详细资料

addMember

@PostMapping("/addMember")
net.risesoft.pojo.Y9Result<Object> addMember(@RequestParam("tenantId") @NotBlank
                                             @NotBlank String tenantId,
                                             @RequestParam("customGroupId") @NotBlank
                                             @NotBlank String customGroupId,
                                             @RequestParam("orgUnitList") @NotEmpty
                                             @NotEmpty List<String> orgUnitList)

添加组成员

参数:

tenantId - 租户id

customGroupId - 用户组id

orgUnitList - 组织id列表

返回:

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

从以下版本开始:

9.6.0

deleteAllGroup

@PostMapping("/deleteAllGroup")
net.risesoft.pojo.Y9Result<Object> deleteAllGroup(@RequestParam("tenantId") @NotBlank
                                                  @NotBlank String tenantId,
                                                  @RequestParam("groupIds") @NotEmpty
                                                  @NotEmpty List<String> groupIds)

删除用户组

参数:

tenantId - 租户id

groupIds - 用户组id，多个用英文逗号,隔开

返回:

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

从以下版本开始:

9.6.0

findCustomGroupByCustomId

@GetMapping("/findCustomGroupByCustomId")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup> findCustomGroupByCustomId(@RequestParam("tenantId") @NotBlank
                                                                                              @NotBlank String tenantId,
                                                                                              @RequestParam("customId") @NotBlank
                                                                                              @NotBlank String customId)

根据自定义id查找自定义用户组

参数:

tenantId - 租户id

customId - 自定义id

返回:

Y9Result<CustomGroup> 通用请求返回对象 - data 是查找的自定义用户组

从以下版本开始:

9.6.0

findCustomGroupById

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

根据id获取用户组

参数:

tenantId - 租户id

personId - 人员Id

groupId - 用户组id

返回:

Y9Result<CustomGroup> 通用请求返回对象 - data 是查找的自定义用户组

从以下版本开始:

9.6.0

listAllPersonByGroupId

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

根据id解析该自定义用户组下的人员列表

参数:

tenantId - 租户id

groupId - 用户组id

返回:

Y9Result<List<Person>> 通用请求返回对象 - data 是查找的人员列表

从以下版本开始:

9.6.0

listCustomGroupByPersonId

@GetMapping("/listCustomGroupByUserId")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.CustomGroup>> listCustomGroupByPersonId(@RequestParam("tenantId") @NotBlank
                                                                                                    @NotBlank String tenantId,
                                                                                                    @RequestParam("personId") @NotBlank
                                                                                                    @NotBlank String personId)

根据人员id获取用户组列表

参数:

tenantId - 租户id

personId - 人员Id

返回:

Y9Result<List<CustomGroup>> 通用请求返回对象 - data 是查找的用户组列表

从以下版本开始:

9.6.0

listCustomGroupMemberByGroupId

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

根据用户组id获取用户组成员

参数:

tenantId - 租户id

personId - 人员Id

groupId - 用户组id

返回:

Y9Result<List<CustomGroupMember>> 通用请求返回对象 - data 是查找的用户组成员列表

从以下版本开始:

9.6.0

listCustomGroupMemberByGroupIdAndMemberType

@GetMapping("/listCustomGroupMemberByGroupIdAndMemberType")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.CustomGroupMember>> listCustomGroupMemberByGroupIdAndMemberType(@RequestParam("tenantId") @NotBlank
                                                                                                                            @NotBlank String tenantId,
                                                                                                                            @RequestParam("personId")
                                                                                                                            String personId,
                                                                                                                            @RequestParam("groupId") @NotBlank
                                                                                                                            @NotBlank String groupId,
                                                                                                                            @RequestParam("memberType")
                                                                                                                            net.risesoft.enums.platform.OrgTypeEnum memberType)

根据用户组id和成员类型，获取用户组成员列表

参数:

tenantId - 租户id

personId - 人员id

groupId - 用户组id

memberType - 成员类型

返回:

Y9Result<List<CustomGroupMember>> 通用请求返回对象 - data 是查找的用户组成员列表

从以下版本开始:

9.6.0

pageCustomGroupByPersonId

@GetMapping("/pageCustomGroupByPersonId")
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroup> pageCustomGroupByPersonId(@RequestParam("tenantId") @NotBlank
                                                                                            @NotBlank String tenantId,
                                                                                            @RequestParam("personId") @NotBlank
                                                                                            @NotBlank String personId,
                                                                                            @Validated
                                                                                            net.risesoft.pojo.Y9PageQuery pageQuery)

根据人员id分页获取其自定义用户组列表

参数:

tenantId - 租户id

personId - 人员id

pageQuery - 分页查询参数

返回:

Y9Page<CustomGroup> 通用分页请求返回对象 - rows 是返回的用户组列表

从以下版本开始:

9.6.0

pageCustomGroupMemberByGroupId

@GetMapping("/pageCustomGroupMemberByGroupId")
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroupMember> pageCustomGroupMemberByGroupId(@RequestParam("tenantId") @NotBlank
                                                                                                       @NotBlank String tenantId,
                                                                                                       @RequestParam("groupId") @NotBlank
                                                                                                       @NotBlank String groupId,
                                                                                                       @Validated
                                                                                                       net.risesoft.pojo.Y9PageQuery pageQuery)

根据自定义用户组id分页获取其自定义用户组成员列表

参数:

tenantId - 租户id

groupId - 用户组Id

pageQuery - 分页查询参数

返回:

Y9Page<CustomGroupMember> 通用分页请求返回对象 - rows 是返回的用户组成员列表

从以下版本开始:

9.6.0

pageCustomGroupMemberByGroupIdAndMemberType

@GetMapping("/pageCustomGroupMemberByGroupIdAndMemberType")
net.risesoft.pojo.Y9Page<net.risesoft.model.platform.CustomGroupMember> pageCustomGroupMemberByGroupIdAndMemberType(@RequestParam("tenantId") @NotBlank
                                                                                                                    @NotBlank String tenantId,
                                                                                                                    @RequestParam("groupId") @NotBlank
                                                                                                                    @NotBlank String groupId,
                                                                                                                    @RequestParam("memberType")
                                                                                                                    net.risesoft.enums.platform.OrgTypeEnum memberType,
                                                                                                                    @Validated
                                                                                                                    net.risesoft.pojo.Y9PageQuery pageQuery)

根据自定义用户组id和成员类型分页获取其自定义用户组成员列表

参数:

tenantId - 租户id

groupId - 用户组Id

memberType - 成员类型

pageQuery - 分页查询参数

返回:

Y9Page<CustomGroupMember>

从以下版本开始:

9.6.0

removeMembers

@PostMapping("/removeMembers")
net.risesoft.pojo.Y9Result<Object> removeMembers(@RequestParam("tenantId") @NotBlank
                                                 @NotBlank String tenantId,
                                                 @RequestParam("memberIds") @NotEmpty
                                                 @NotEmpty List<String> memberIds)

删除组成员

参数:

tenantId - 租户id

memberIds - 用户组成员id，多个用英文逗号,隔开

返回:

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

从以下版本开始:

9.6.0

saveCustomGroup

@PostMapping("/saveCustomGroup")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup> saveCustomGroup(@RequestParam("tenantId") @NotBlank
                                                                                    @NotBlank String tenantId,
                                                                                    @RequestBody
                                                                                    net.risesoft.model.platform.CustomGroup customGroup)

保存自定义用户组

参数:

tenantId - 租户id

customGroup - 自定义用户组

返回:

Y9Result<CustomGroup> 通用请求返回对象 - data 是保存的自定义用户组

从以下版本开始:

9.6.0

saveCustomGroupOrder

@PostMapping("/saveCustomGroupOrder")
net.risesoft.pojo.Y9Result<Object> saveCustomGroupOrder(@RequestParam("tenantId") @NotBlank
                                                        @NotBlank String tenantId,
                                                        @RequestParam("sortIds") @NotEmpty
                                                        @NotEmpty List<String> sortIds)

保存自定义用户组排序

参数:

tenantId - 租户id

sortIds - 排序后的用户组id，多个用英文逗号,隔开

返回:

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

从以下版本开始:

9.6.0

saveMemberOrder

@PostMapping("/saveMemberOrder")
net.risesoft.pojo.Y9Result<Object> saveMemberOrder(@RequestParam("tenantId") @NotBlank
                                                   @NotBlank String tenantId,
                                                   @RequestParam("memberIds") @NotEmpty
                                                   @NotEmpty List<String> memberIds)

保存自定义用户组成员排序

参数:

tenantId - 租户id

memberIds - 排序的用户组成员id，多个用英文逗号,隔开

返回:

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

从以下版本开始:

9.6.0

saveOrUpdateCustomGroup

@PostMapping("/saveOrUpdateCustomGroup")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.CustomGroup> saveOrUpdateCustomGroup(@RequestParam("tenantId") @NotBlank
                                                                                            @NotBlank String tenantId,
                                                                                            @RequestParam("personId") @NotBlank
                                                                                            @NotBlank String personId,
                                                                                            @RequestParam("personIds") @NotEmpty
                                                                                            @NotEmpty List<String> personIds,
                                                                                            @RequestParam("groupId")
                                                                                            String groupId,
                                                                                            @RequestParam("groupName") @NotBlank
                                                                                            @NotBlank String groupName)

保存用户组

参数:

tenantId - 租户id

personId - 人员id

personIds - 人员id，多个用英文逗号,隔开

groupId - 用户组Id

groupName - 用户组名称

返回:

Y9Result<CustomGroup> 通用请求返回对象 - data 是保存的自定义用户组

从以下版本开始:

9.6.0

shareCustomGroup

@PostMapping("/shareCustomGroup")
net.risesoft.pojo.Y9Result<Object> shareCustomGroup(@RequestParam("tenantId") @NotBlank
                                                    @NotBlank String tenantId,
                                                    @RequestParam("personIds") @NotEmpty
                                                    @NotEmpty List<String> personIds,
                                                    @RequestParam("groupIds") @NotEmpty
                                                    @NotEmpty List<String> groupIds)

分享用户组给其他人使用

参数:

tenantId - 租户id

personIds - 人员id，多个用英文逗号,隔开

groupIds - 用户组id，多个用英文逗号,隔开

返回:

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

从以下版本开始:

9.6.0