public class UserSearchParams extends Object
This allows you to include or exclude active and inactive users and allow or disallow empty search queries.
Modifier and Type | Class and Description |
---|---|
static class |
UserSearchParams.Builder |
Modifier and Type | Field and Description |
---|---|
static UserSearchParams |
ACTIVE_USERS_ALLOW_EMPTY_QUERY |
static UserSearchParams |
ACTIVE_USERS_IGNORE_EMPTY_QUERY |
Constructor and Description |
---|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive)
Creates user search params.
|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive,
boolean canMatchEmail,
UserFilter userFilter,
Set<Long> projectIds)
Creates user search params.
|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive,
boolean canMatchEmail,
UserFilter userFilter,
Set<Long> projectIds,
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter)
Creates user search params.
|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive,
boolean canMatchEmail,
UserFilter userFilter,
Set<Long> projectIds,
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
Integer maxResults)
Creates user search params.
|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive,
boolean canMatchEmail,
UserFilter userFilter,
Set<Long> projectIds,
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
Integer maxResults,
boolean sorted)
Creates user search params.
|
UserSearchParams(boolean allowEmptyQuery,
boolean includeActive,
boolean includeInactive,
boolean canMatchEmail,
UserFilter userFilter,
Set<Long> projectIds,
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
Integer maxResults,
boolean sorted,
boolean ignorePermissionCheck)
Creates user search params.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowEmptyQuery() |
static UserSearchParams.Builder |
builder() |
static UserSearchParams.Builder |
builder(UserSearchParams prototype) |
boolean |
canMatchEmail() |
boolean |
equals(Object o) |
Integer |
getMaxResults() |
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> |
getPostProcessingFilter() |
Set<Long> |
getProjectIds() |
UserFilter |
getUserFilter() |
int |
hashCode() |
boolean |
ignorePermissionCheck() |
boolean |
includeActive() |
boolean |
includeInactive() |
boolean |
isSorted() |
public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY
public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY
public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.canMatchEmail
- if search applies to email address as well.userFilter
- filter users by groups or roles.projectIds
- the list of project ids to be used in conjunction with the roles in user filter.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.canMatchEmail
- if search applies to email address as well.userFilter
- filter users by groups or roles.projectIds
- the list of project ids to be used in conjunction with the roles in user filter.postProcessingFilter
- a filter applied after search results are retrieved. Use this for more complex
filter logic that can't be expressed in userFilter
and the other parameters.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.canMatchEmail
- if search applies to email address as well.userFilter
- filter users by groups or roles.projectIds
- the list of project ids to be used in conjunction with the roles in user filter.postProcessingFilter
- a filter applied after search results are retrieved. Use this for more complex
filter logic that can't be expressed in userFilter
and the other parameters.maxResults
- the maximum number of results to retrieve. Use null
for unlimited results.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults, boolean sorted)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.canMatchEmail
- if search applies to email address as well.userFilter
- filter users by groups or roles.projectIds
- the list of project ids to be used in conjunction with the roles in user filter.postProcessingFilter
- a filter applied after search results are retrieved. Use this for more complex
filter logic that can't be expressed in userFilter
and the other parameters.maxResults
- the maximum number of results to retrieve. Use null
for unlimited results.sorted
- if true, results are guaranteed to be sorted. If false, results may be unsorted which might
have better performance.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults, boolean sorted, boolean ignorePermissionCheck)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.canMatchEmail
- if search applies to email address as well.userFilter
- filter users by groups or roles.projectIds
- the list of project ids to be used in conjunction with the roles in user filter.postProcessingFilter
- a filter applied after search results are retrieved. Use this for more complex
filter logic that can't be expressed in userFilter
and the other parameters.maxResults
- the maximum number of results to retrieve. Use null
for unlimited results.sorted
- if true, results are guaranteed to be sorted. If false, results may be unsorted which might
have better performance.ignorePermissionCheck
- a flag that indicates whether a browser users permission check will be performed.public boolean allowEmptyQuery()
public boolean includeActive()
public boolean includeInactive()
public boolean canMatchEmail()
public UserFilter getUserFilter()
public boolean ignorePermissionCheck()
@Nonnull public com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> getPostProcessingFilter()
public Integer getMaxResults()
public boolean isSorted()
public static UserSearchParams.Builder builder()
public static UserSearchParams.Builder builder(UserSearchParams prototype)
Copyright © 2002-2019 Atlassian. All Rights Reserved.