com.atlassian.jira.bc.user.search

Class UserSearchParams

java.lang.Object

com.atlassian.jira.bc.user.search.UserSearchParams

public class UserSearchParams
extends Object

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.

Since:

v5.1.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSearchParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static UserSearchParams	ACTIVE_USERS_ALLOW_EMPTY_QUERY
static UserSearchParams	ACTIVE_USERS_IGNORE_EMPTY_QUERY

Constructor Summary

Constructors

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.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVE_USERS_IGNORE_EMPTY_QUERY

public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY

ACTIVE_USERS_ALLOW_EMPTY_QUERY

public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY

Constructor Detail

UserSearchParams

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.

UserSearchParams

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.

Since:

v6.2

UserSearchParams

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)

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.

Since:

v7.0

UserSearchParams

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)

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.

Since:

v7.0

UserSearchParams

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)

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.

Since:

v7.0

UserSearchParams

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)

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.

Since:

v7.0

Method Detail

allowEmptyQuery

public boolean allowEmptyQuery()

includeActive

public boolean includeActive()

includeInactive

public boolean includeInactive()

canMatchEmail

public boolean canMatchEmail()

getUserFilter

public UserFilter getUserFilter()

getProjectIds

public Set<Long> getProjectIds()

ignorePermissionCheck

public boolean ignorePermissionCheck()

Since:

v7.0

getPostProcessingFilter

@Nonnull
public com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> getPostProcessingFilter()

Since:

v7.0

getMaxResults

public Integer getMaxResults()

Since:

v7.0

isSorted

public boolean isSorted()

Since:

v7.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static UserSearchParams.Builder builder()

builder

public static UserSearchParams.Builder builder(UserSearchParams prototype)