|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@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 |
---|
List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext, String query)
Matches on the start of username and each word in Full Name & email. Only returns active users.
Results are sorted according to the UserCachingComparator
.
jiraServiceContext
- Jira Service Contextquery
- String to search for.
User
objects that match criteria.findUsers(com.atlassian.jira.bc.JiraServiceContext, String, UserSearchParams)
com.atlassian.crowd.embedded.api.User getUserByName(JiraServiceContext jiraServiceContext, String query)
jiraServiceContext
- Jira Service Contextquery
- String to search for.
User
object with supplied username.List<com.atlassian.crowd.embedded.api.User> findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext, String query)
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
.
jiraServiceContext
- Jira Service Contextquery
- String to search for.
User
objects that match criteria.findUsers(com.atlassian.jira.bc.JiraServiceContext, String, UserSearchParams)
List<com.atlassian.crowd.embedded.api.User> findUsers(JiraServiceContext jiraServiceContext, String query, UserSearchParams userSearchParams)
Matches on the start of username and each word in Full Name & email.
Results are sorted according to the UserCachingComparator
.
jiraServiceContext
- Jira Service Contextquery
- String to search for.userSearchParams
- Additional search parameters
User
objects that match criteria.List<com.atlassian.crowd.embedded.api.User> findUsers(String query, UserSearchParams userSearchParams)
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.
query
- the query to search username, display name and email addressuserSearchParams
- the search criteria
List<com.atlassian.crowd.embedded.api.User> findUsers(String nameQuery, String emailQuery, UserSearchParams userSearchParams)
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.
nameQuery
- the query to search username and display name.emailQuery
- the query to search email address, subject to userSearchParams.canMatchEmail.userSearchParams
- the search criteria
boolean userMatches(ApplicationUser user, UserSearchParams userSearchParams)
userSearchParams
parameter.
allowEmptyQuery in userSearchParams
is ignored.
user
- the user to be matcheduserSearchParams
- the search criteria
boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext)
jiraServiceContext
- Jira Service Context
boolean canPerformAjaxSearch(com.atlassian.crowd.embedded.api.User user)
canPerformAjaxSearch(com.atlassian.jira.user.ApplicationUser)
instead.
boolean canPerformAjaxSearch(ApplicationUser user)
boolean canShowEmailAddresses(JiraServiceContext jiraServiceContext)
jiraServiceContext
- Jira Service Context
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |