com.atlassian.jira.bc.user.search
Interface UserPickerSearchService

All Known Implementing Classes:
DefaultUserPickerSearchService

@PublicApi
public interface UserPickerSearchService

Service that retrieves a collection of User objects based on a partial query string


Method Summary
 boolean canPerformAjaxSearch(ApplicationUser user)
          Determines whether the given user could perform AJAX search.
 boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext)
          Returns true only if UserPicker Ajax search is enabled AND the user in the context has User Browse permission.
 boolean canPerformAjaxSearch(com.atlassian.crowd.embedded.api.User user)
          Deprecated. since v6.2. Use canPerformAjaxSearch(com.atlassian.jira.user.ApplicationUser) instead.
 boolean canShowEmailAddresses(JiraServiceContext jiraServiceContext)
          Whether or not the UserPicker Ajax should search or show email addresses
 List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext, String query)
          Get Users based on a query string.
 List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext, String query, UserSearchParams userSearchParams)
          Get Users based on a query string.
 List<com.atlassian.crowd.embedded.api.User> findUsers(String nameQuery, String emailQuery, UserSearchParams userSearchParams)
          Get Users based on query strings.
 List<com.atlassian.crowd.embedded.api.User> findUsers(String query, UserSearchParams userSearchParams)
          Get Users based on a query string.
 List<com.atlassian.crowd.embedded.api.User> findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext, String query)
          Get Users based on a query string.
 com.atlassian.crowd.embedded.api.User getUserByName(JiraServiceContext jiraServiceContext, String query)
          Returns a user by exact username
 boolean userMatches(ApplicationUser user, UserSearchParams userSearchParams)
          Determine whether a user matches the search criteria specified in the userSearchParams parameter.
 

Method Detail

findUsers

List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext,
                                                      String query)
Get Users based on a query string.

Matches on the start of username and each word in Full Name & email. Only returns active users.

Results are sorted according to the UserCachingComparator.

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
Returns:
List of User objects that match criteria.
See Also:
findUsers(com.atlassian.jira.bc.JiraServiceContext, String, UserSearchParams)

getUserByName

com.atlassian.crowd.embedded.api.User getUserByName(JiraServiceContext jiraServiceContext,
                                                    String query)
Returns a user by exact username

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
Returns:
The User object with supplied username.

findUsersAllowEmptyQuery

List<com.atlassian.crowd.embedded.api.User> findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext,
                                                                     String query)
Get Users based on a query string.

Matches on the start of username and each word in Full Name & email. This will search even if the query passed is null or empty. Only returns active users.

Results are sorted according to the UserCachingComparator.

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
Returns:
List of User objects that match criteria.
See Also:
findUsers(com.atlassian.jira.bc.JiraServiceContext, String, UserSearchParams)

findUsers

List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext,
                                                      String query,
                                                      UserSearchParams userSearchParams)
Get Users based on a query string.

Matches on the start of username and each word in Full Name & email.

Results are sorted according to the UserCachingComparator.

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
userSearchParams - Additional search parameters
Returns:
List of User objects that match criteria.
Since:
5.1.5

findUsers

List<com.atlassian.crowd.embedded.api.User> findUsers(String query,
                                                      UserSearchParams userSearchParams)
Get Users based on a query string.

Matches on the start of username and each word in Full Name & email.

Matches email only when userSearchParams.canMatchEmail() is true. Results are sorted according to the userSearchParams.comparator. If userSearchParams.comparator is null, no sorting will be performed.

Parameters:
query - the query to search username, display name and email address
userSearchParams - the search criteria
Returns:
the list of matched users
Since:
6.2

findUsers

List<com.atlassian.crowd.embedded.api.User> findUsers(String nameQuery,
                                                      String emailQuery,
                                                      UserSearchParams userSearchParams)
Get Users based on query strings.

Matches nameQuery on the start of username and each word in Full Name & email.

Matches emailQuery on start of email. Email matching is performed only when userSearchParams.canMatchEmail() is true. Results are sorted according to the userSearchParams.comparator. If userSearchParams.comparator is null, no sorting will be performed.

Parameters:
nameQuery - the query to search username and display name.
emailQuery - the query to search email address, subject to userSearchParams.canMatchEmail.
userSearchParams - the search criteria
Returns:
the list of matched users
Since:
6.2

userMatches

boolean userMatches(ApplicationUser user,
                    UserSearchParams userSearchParams)
Determine whether a user matches the search criteria specified in the userSearchParams parameter.

allowEmptyQuery in userSearchParams is ignored.

Parameters:
user - the user to be matched
userSearchParams - the search criteria
Returns:
true if the user matches the search criteria
Since:
v6.2

canPerformAjaxSearch

boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext)
Returns true only if UserPicker Ajax search is enabled AND the user in the context has User Browse permission.

Parameters:
jiraServiceContext - Jira Service Context
Returns:
True if enabled, otherwise false

canPerformAjaxSearch

boolean canPerformAjaxSearch(com.atlassian.crowd.embedded.api.User user)
Deprecated. since v6.2. Use canPerformAjaxSearch(com.atlassian.jira.user.ApplicationUser) instead.


canPerformAjaxSearch

boolean canPerformAjaxSearch(ApplicationUser user)
Determines whether the given user could perform AJAX search.

Since:
v6.2

canShowEmailAddresses

boolean canShowEmailAddresses(JiraServiceContext jiraServiceContext)
Whether or not the UserPicker Ajax should search or show email addresses

Parameters:
jiraServiceContext - Jira Service Context
Returns:
True if email addresses can be shown, otherwise false


Copyright © 2002-2015 Atlassian. All Rights Reserved.