com.atlassian.jira.bc.user.search.UserPickerSearchService |
Known Indirect Subclasses |
This interface is deprecated.
Use UserSearchService
instead. Since v7.0.
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
Service that retrieves a collection of ApplicationUser
objects based on a partial query string
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns true only if UserPicker Ajax search is enabled AND the user in the context has com.atlassian.jira.user.ApplicationUser Browse permission.
| |||||||||||
Determines whether the given user could perform AJAX search.
| |||||||||||
Whether or not the UserPicker Ajax should search or show email addresses
| |||||||||||
Get Users based on a query string.
| |||||||||||
Get Users based on a query string.
| |||||||||||
Get Users based on query strings.
| |||||||||||
Get Users based on a query string.
| |||||||||||
Get Users based on a query string.
| |||||||||||
Returns a user by exact username
| |||||||||||
Determine whether a user matches the search criteria specified in the
userSearchParams parameter. |
Returns true only if UserPicker Ajax search is enabled AND the user in the context has com.atlassian.jira.user.ApplicationUser Browse permission.
jiraServiceContext | Jira Service Context |
---|
Determines whether the given user could perform AJAX search.
Whether or not the UserPicker Ajax should search or show email addresses
jiraServiceContext | Jira Service Context |
---|
Get Users based on a query string.
Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words
Results are sorted according to the UserCachingComparator
.
If the users in the database change during this call results might not be consistent if a
post processing filter
and a result limit is used.
jiraServiceContext | Jira Service Context |
---|---|
query | String to search for. |
userSearchParams | Additional search parameters |
ApplicationUser
objects that match criteria.Get Users based on a query string.
Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words Only returns active users.
Results are sorted according to the UserCachingComparator
.
jiraServiceContext | Jira Service Context |
---|---|
query | String to search for. |
ApplicationUser
objects that match criteria.Get Users based on query strings.
Matches nameQuery on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words
Matches emailQuery on start of email, as well as the tokenised words. 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.
If the users in the database change during this call results might not be consistent if a
post processing filter
and a result limit is used.
nameQuery | the query to search username and display name. |
---|---|
emailQuery | the query to search email address, subject to userSearchParams.canMatchEmail. |
userSearchParams | the search criteria |
Get Users based on a query string.
Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words
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.
If the users in the database change during this call results might not be consistent if a
post processing filter
and a result limit is used.
query | the query to search username, display name and email address |
---|---|
userSearchParams | the search criteria |
Get Users based on a query string.
Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words 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 Context |
---|---|
query | String to search for. |
ApplicationUser
objects that match criteria.Returns a user by exact username
jiraServiceContext | Jira Service Context |
---|---|
query | String to search for. |
ApplicationUser
object with supplied username.
Determine whether a user matches the search criteria specified in the userSearchParams
parameter.
allowEmptyQuery in userSearchParams
is ignored.
user | the user to be matched |
---|---|
userSearchParams | the search criteria |