com.atlassian.jira.rest.v2.issue.users

Interface UserPickerResourceHelper

All Known Implementing Classes:

UserPickerResourceHelperImpl

public interface UserPickerResourceHelper

Method Summary

Modifier and Type	Method and Description
List<ApplicationUser>	findActiveUsers(String searchString) Finds active users, throws exception if search string is null
List<ApplicationUser>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive) Finds users, throws exception if search string is null
List<ApplicationUser>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString) Finds users, throws exception if search string is null
List<ApplicationUser>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> filter) Finds users, throws exception if search string is null
List<ApplicationUser>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> filter, Integer maxResults) Finds users, throws exception if search string is null
List<ApplicationUser>	findUsers(String searchString, UserSearchParams userSearchParams) Finds users, throws exception if search string is null
UserPickerResultsBean	findUsersAsBean(String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers) Returns a list of users matching query with highlighting.
UserPickerResultsBean	findUsersAsBean(String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers, UserSearchParams userSearchParams) Returns a list of users matching query with highlighting.
ApplicationUser	getUserByName(String userName) Returns a user if supplied userName is exact match to their username.
List<ApplicationUser>	limitUserSearch(Integer startAt, Integer maxResults, Iterable<ApplicationUser> users, Iterable<String> excludeUsers)

Method Detail

findUsersAsBean

UserPickerResultsBean findUsersAsBean(String query,
                                      Integer maxResults,
                                      Boolean showAvatar,
                                      List<String> excludeUsers)

Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.

Parameters:

query - A string used to search username, Name or e-mail address. Empty query is not allowed.

maxResults - the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.

showAvatar - get avatar url

excludeUsers - exclude these users from search results

Returns:

An object containing list of matched user objects, with html representing highlighting.

findUsersAsBean

UserPickerResultsBean findUsersAsBean(String query,
                                      Integer maxResults,
                                      Boolean showAvatar,
                                      List<String> excludeUsers,
                                      UserSearchParams userSearchParams)

Returns a list of users matching query with highlighting. This resource cannot be assessed anonymously.

Parameters:

query - A string used to search username, Name or e-mail address. Empty query is not allowed.

maxResults - the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.

showAvatar - get avatar url

excludeUsers - exclude these users from search results

userSearchParams - additional search parameters. allowEmptyQuery is ignored, always treated as false.

Returns:

An object containing list of matched user objects, with html representing highlighting.

Since:

v6.1

limitUserSearch

List<ApplicationUser> limitUserSearch(Integer startAt,
                                      Integer maxResults,
                                      Iterable<ApplicationUser> users,
                                      Iterable<String> excludeUsers)

Parameters:

startAt - start the search at this index

maxResults - max results

users - search results to limit

excludeUsers - exclude these users from search results

Returns:

adjusted search results

findActiveUsers

List<ApplicationUser> findActiveUsers(String searchString)

Finds active users, throws exception if search string is null

Parameters:

searchString - user query

Returns:

List of matching users

findUsers

List<ApplicationUser> findUsers(String searchString,
                                Boolean includeActive,
                                Boolean includeInactive)

Finds users, throws exception if search string is null

Parameters:

searchString - user query, no users returned if empty

includeActive - whether to include active users (null implies true)

includeInactive - whether to include inactive users (null implies false)

Returns:

List of matching users

findUsers

List<ApplicationUser> findUsers(String searchString,
                                UserSearchParams userSearchParams)

Finds users, throws exception if search string is null

Parameters:

searchString - user query

userSearchParams - search parameters, including "includeActive", "includeInactive", etc. allowEmptyQuery is ignored, always treated as false.

Returns:

List of matching users

findUsers

List<ApplicationUser> findUsers(String searchString,
                                Boolean includeActive,
                                Boolean includeInactive,
                                boolean allowEmptySearchString)

Finds users, throws exception if search string is null

Parameters:

searchString - user query

allowEmptySearchString - controls whether users are returned if searchString is empty

includeActive - whether to include active users (null implies true)

includeInactive - whether to include inactive users (null implies false)

Returns:

List of matching users

findUsers

List<ApplicationUser> findUsers(String searchString,
                                Boolean includeActive,
                                Boolean includeInactive,
                                boolean allowEmptySearchString,
                                com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> filter)

Finds users, throws exception if search string is null

Parameters:

searchString - user query

allowEmptySearchString - controls whether users are returned if searchString is empty

includeActive - whether to include active users (null implies true)

includeInactive - whether to include inactive users (null implies false)

filter - filter to post-process user results with. May be null for no filtering.

Returns:

List of matching users

findUsers

List<ApplicationUser> findUsers(String searchString,
                                Boolean includeActive,
                                Boolean includeInactive,
                                boolean allowEmptySearchString,
                                com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> filter,
                                Integer maxResults)

Finds users, throws exception if search string is null

Parameters:

searchString - user query

allowEmptySearchString - controls whether users are returned if searchString is empty

includeActive - whether to include active users (null implies true)

includeInactive - whether to include inactive users (null implies false)

filter - filter to post-process user results with. May be null for no filtering.

maxResults - the result limit, use null for no limit.

Returns:

List of matching users

getUserByName

ApplicationUser getUserByName(String userName)

Returns a user if supplied userName is exact match to their username.

Parameters:

userName - The username query

Returns:

User The exact user or null if not found.