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(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)
           
 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> 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
 

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

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)

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-2014 Atlassian. All Rights Reserved.