com.atlassian.confluence.api.service.people

Interface PersonService.PersonFinder

All Superinterfaces:

ManyFetcher<Person>, PersonService.SinglePersonFetcher, SingleFetcher<Person>

All Known Implementing Classes:

NoopPersonFinder, PersonServiceImpl.PersonFinderImpl

Enclosing interface:

PersonService

public static interface PersonService.PersonFinder
extends PersonService.SinglePersonFetcher, ManyFetcher<Person>

A finder for locating persons.

Method Summary

Modifier and Type	Method and Description
PersonService.PersonFinder	withMembershipOf(Group group) Restrict the finder to just users that are members of the given group
PersonService.PersonFinder	withUserKey(com.atlassian.sal.api.user.UserKey userKey) Restrict the finder to just the user with the given userKey
PersonService.SinglePersonFetcher	withUsername(String username) Restrict the finder to just user with the given username

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

fetch, fetchOne, fetchOneOrNull, fetchOrNull

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

fetchMany

Method Detail

withUserKey

PersonService.PersonFinder withUserKey(com.atlassian.sal.api.user.UserKey userKey)

Restrict the finder to just the user with the given userKey

Returns:

this

withUsername

PersonService.SinglePersonFetcher withUsername(String username)

Restrict the finder to just user with the given username

Returns:

this

withMembershipOf

PersonService.PersonFinder withMembershipOf(Group group)

Restrict the finder to just users that are members of the given group

Returns:

this