com.atlassian.jira.bc.user.search
Class DefaultUserPickerSearchService

java.lang.Object
  com.atlassian.jira.bc.user.search.DefaultUserPickerSearchService

All Implemented Interfaces:

UserPickerSearchService

public class DefaultUserPickerSearchService
extends Object
implements UserPickerSearchService

Constructor Summary

DefaultUserPickerSearchService(UserManager userManager, ApplicationProperties applicationProperties, PermissionManager permissionManager)
Constructs a DefaultUserPickerSearchService

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>	findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext, String query) Get Users based on a query string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUserPickerSearchService

public DefaultUserPickerSearchService(UserManager userManager,
                                      ApplicationProperties applicationProperties,
                                      PermissionManager permissionManager)

Constructs a DefaultUserPickerSearchService

Parameters:

userManager - the UserUtil needed

applicationProperties - the ApplicationProperties

permissionManager - needed to resolve permissions

Method Detail

findUsers

public List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext,
                                                             String query)

Description copied from interface: UserPickerSearchService

Get Users based on a query string.

Matches on the start of username, Each word in Full Name & email.

Results are sorted according to the UserBestNameComparator.

Specified by:

findUsers in interface UserPickerSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

Returns:

List of User objects that match criteria.

findUsersAllowEmptyQuery

public List<com.atlassian.crowd.embedded.api.User> findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext,
                                                                            String query)

Description copied from interface: UserPickerSearchService

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.

Results are sorted according to the UserBestNameComparator.

Specified by:

findUsersAllowEmptyQuery in interface UserPickerSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

Returns:

List of User objects that match criteria.

canShowEmailAddresses

public boolean canShowEmailAddresses(JiraServiceContext jiraServiceContext)

Description copied from interface: UserPickerSearchService

Whether or not the UserPicker Ajax should search or show email addresses

Specified by:

canShowEmailAddresses in interface UserPickerSearchService

Parameters:

jiraServiceContext - Jira Service Context

Returns:

True if email addresses can be shown, otherwise false

See Also:

UserPickerSearchService.canShowEmailAddresses(com.atlassian.jira.bc.JiraServiceContext)

canPerformAjaxSearch

public boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext)

Description copied from interface: UserPickerSearchService

Returns true only if UserPicker Ajax search is enabled AND the user in the context has User Browse permission.

Specified by:

canPerformAjaxSearch in interface UserPickerSearchService

Parameters:

jiraServiceContext - Jira Service Context

Returns:

True if enabled, otherwise false

canPerformAjaxSearch

public boolean canPerformAjaxSearch(com.atlassian.crowd.embedded.api.User user)

Specified by:

canPerformAjaxSearch in interface UserPickerSearchService

See Also:

UserPickerSearchService.canPerformAjaxSearch(com.atlassian.jira.bc.JiraServiceContext)