Package com.atlassian.confluence.api.service.people

Interface GroupService.GroupFinder

All Superinterfaces:

ManyFetcher<Group>, SingleFetcher<Group>

All Known Implementing Classes:

GroupServiceImpl.GroupFinderImpl, NoopGroupFinder

Enclosing interface:

GroupService

public static interface GroupService.GroupFinder
extends SingleFetcher<Group>, ManyFetcher<Group>

A finder for locating groups

Method Summary

Modifier and Type	Method	Description
GroupService.GroupFinder	withAncestorOf(Group group)	Restrict the finder to find groups that are ancestor of the given group
GroupService.GroupFinder	withMember(User person)	Filter to groups that have the given person as a member
GroupService.GroupFinder	withMembershipOf(Group group)	Restrict the finder to find groups that are members of the given group
SingleFetcher<Group>	withName(String groupName)	Restrict the fetched group to matching the given groupName
GroupService.GroupFinder	withParentOf(Group group)	Restrict the finder to find groups that are parents of the given group

Methods inherited from interface com.atlassian.confluence.api.service.finder.ManyFetcher

fetchMany

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetch, fetchOneOrNull, fetchOrNull

Method Details

withName

SingleFetcher<Group> withName(String groupName)

Restrict the fetched group to matching the given groupName

Parameters:

groupName - the name of the group to match

Returns:

a fetcher with the filter applied.

withMember

GroupService.GroupFinder withMember(User person)

Filter to groups that have the given person as a member

Returns:

this

withMembershipOf

GroupService.GroupFinder withMembershipOf(Group group)

Restrict the finder to find groups that are members of the given group

Returns:

this

Since:

9.2.6

withParentOf

GroupService.GroupFinder withParentOf(Group group)

Restrict the finder to find groups that are parents of the given group

Returns:

this

Since:

9.2.6

withAncestorOf

GroupService.GroupFinder withAncestorOf(Group group)

Restrict the finder to find groups that are ancestor of the given group

Returns:

this

Since:

9.2.6