public class

UserSearchParams

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.user.search.UserSearchParams

Class Overview

Optional parameters to restrict a user search.

This allows you to include or exclude active and inactive users and allow or disallow empty search queries.

Summary

Nested Classes
class UserSearchParams.Builder  
Fields
public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY
public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY
Public Constructors
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, Predicate<User> postProcessingFilter)
Creates user search params.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, Predicate<User> postProcessingFilter, Integer maxResults)
Creates user search params.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, Predicate<User> postProcessingFilter, Integer maxResults, boolean sorted)
Creates user search params.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, Predicate<User> postProcessingFilter, Integer maxResults, boolean sorted, boolean ignorePermissionCheck)
Creates user search params.
Public Methods
boolean allowEmptyQuery()
static UserSearchParams.Builder builder(UserSearchParams prototype)
static UserSearchParams.Builder builder()
boolean canMatchEmail()
boolean equals(Object o)
Integer getMaxResults()
@Nonnull Predicate<User> getPostProcessingFilter()
Set<Long> getProjectIds()
UserFilter getUserFilter()
int hashCode()
boolean ignorePermissionCheck()
boolean includeActive()
boolean includeInactive()
boolean isSorted()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY

public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY

Public Constructors

public UserSearchParams (boolean allowEmptyQuery, boolean includeActive, boolean includeInactive)

Creates user search params.

Parameters
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)

Creates user search params.

Parameters
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, Predicate<User> postProcessingFilter)

Creates user search params.

Parameters
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, Predicate<User> postProcessingFilter, Integer maxResults)

Creates user search params.

Parameters
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, Predicate<User> postProcessingFilter, Integer maxResults, boolean sorted)

Creates user search params.

Parameters
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, Predicate<User> postProcessingFilter, Integer maxResults, boolean sorted, boolean ignorePermissionCheck)

Creates user search params.

Parameters
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 Methods

public boolean allowEmptyQuery ()

public static UserSearchParams.Builder builder (UserSearchParams prototype)

public static UserSearchParams.Builder builder ()

public boolean canMatchEmail ()

public boolean equals (Object o)

public Integer getMaxResults ()

@Nonnull public Predicate<User> getPostProcessingFilter ()

public Set<Long> getProjectIds ()

public UserFilter getUserFilter ()

public int hashCode ()

public boolean ignorePermissionCheck ()

public boolean includeActive ()

public boolean includeInactive ()

public boolean isSorted ()