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

All Known Implementing Classes:
DefaultUserPickerSearchService

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 canShowEmailAddresses(JiraServiceContext jiraServiceContext)
          Whether or not the UserPicker Ajax should search or show email addresses
 java.util.Collection<com.opensymphony.user.User> getResults(JiraServiceContext jiraServiceContext, java.lang.String query)
          Get Users based on a query string.
 java.util.Collection<com.opensymphony.user.User> getResultsSearchForEmptyQuery(JiraServiceContext jiraServiceContext, java.lang.String query)
          Get Users based on a query string.
 boolean isAjaxSearchEnabled()
          Returns true only if UserPicker Ajax search is enabled.
 

Method Detail

getResults

java.util.Collection<com.opensymphony.user.User> getResults(JiraServiceContext jiraServiceContext,
                                                            java.lang.String query)
Get Users based on a query string. Matches on the start of username, Each word in Full Name & email

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
Returns:
Collection of User objects that match criteria.

getResultsSearchForEmptyQuery

java.util.Collection<com.opensymphony.user.User> getResultsSearchForEmptyQuery(JiraServiceContext jiraServiceContext,
                                                                               java.lang.String query)
Get Users based on a query string. Matches on the start of username, Each word in Full Name & email. This will search even if the query passed is null or empty.

Parameters:
jiraServiceContext - Jira Service Context
query - String to search for.
Returns:
Collection of User objects that match criteria.

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

isAjaxSearchEnabled

boolean isAjaxSearchEnabled()
Returns true only if UserPicker Ajax search is enabled.

Returns:
true if enabled.

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