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

All Known Implementing Classes:

UserPickerResourceHelperImpl

public interface UserPickerResourceHelper

Method Summary

List<com.atlassian.crowd.embedded.api.User>	findActiveUsers(String searchString) Finds active users, throws exception if search string is null
List<com.atlassian.crowd.embedded.api.User>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive) Finds users, throws exception if search string is null
List<com.atlassian.crowd.embedded.api.User>	findUsers(String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString) 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.
com.atlassian.crowd.embedded.api.User	getUserByName(String userName) Returns a user if supplied userName is exact match to their username.
List<com.atlassian.crowd.embedded.api.User>	limitUserSearch(Integer startAt, Integer maxResults, Iterable<com.atlassian.crowd.embedded.api.User> 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

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.

limitUserSearch

List<com.atlassian.crowd.embedded.api.User> limitUserSearch(Integer startAt,
                                                            Integer maxResults,
                                                            Iterable<com.atlassian.crowd.embedded.api.User> 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<com.atlassian.crowd.embedded.api.User> findActiveUsers(String searchString)

Finds active users, throws exception if search string is null

Parameters:

searchString - user query

Returns:

List of matching users

findUsers

List<com.atlassian.crowd.embedded.api.User> 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<com.atlassian.crowd.embedded.api.User> 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

getUserByName

com.atlassian.crowd.embedded.api.User 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.