com.atlassian.jira.bc.user.search

Class UserSearchParams.Builder

java.lang.Object

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

Enclosing class:

UserSearchParams

public static class UserSearchParams.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder() Deprecated.
Builder(int limit)

Method Summary

Modifier and Type	Method and Description
UserSearchParams.Builder	allowEmptyQuery(boolean allowEmptyQuery)
UserSearchParams	build()
UserSearchParams.Builder	canMatchEmail(boolean canMatchEmail)
UserSearchParams.Builder	filter(com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter) Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9.
UserSearchParams.Builder	filter(UserFilter userFilter)
UserSearchParams.Builder	filterByProjectIds(Collection<Long> projectIds)
UserSearchParams.Builder	forceStrongConsistency(boolean forceStrongConsistency)
UserSearchParams.Builder	ignorePermissionCheck(boolean ignorePermissionCheck)
UserSearchParams.Builder	includeActive(boolean includeActive)
UserSearchParams.Builder	includeInactive(boolean includeInactive)
UserSearchParams.Builder	limitResults(int limit)
UserSearchParams.Builder	maxResults(Integer maxResults) Deprecated. Use limitResults(int) instead.
UserSearchParams.Builder	sorted(boolean sorted)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

@Deprecated
public Builder()

Deprecated.

Builder

public Builder(int limit)

Parameters:

limit - the maximum number of results to retrieve using constructed UserSearchParams. The maximum allowed is 100. If higher number is provided it will be set to 100 in resulting UserSearchParams.

Since:

v8.20

Method Detail

build

public UserSearchParams build()

allowEmptyQuery

public UserSearchParams.Builder allowEmptyQuery(boolean allowEmptyQuery)

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive

public UserSearchParams.Builder includeActive(boolean includeActive)

Parameters:

includeActive - active users are searched.

includeInactive

public UserSearchParams.Builder includeInactive(boolean includeInactive)

Parameters:

includeInactive - inactive users are searched.

canMatchEmail

public UserSearchParams.Builder canMatchEmail(boolean canMatchEmail)

Parameters:

canMatchEmail - if search applies to email address as well.

filter

public UserSearchParams.Builder filter(UserFilter userFilter)

Parameters:

userFilter - filter users by groups or roles.

Since:

v6.2

filterByProjectIds

public UserSearchParams.Builder filterByProjectIds(Collection<Long> projectIds)

Parameters:

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

Since:

v6.2

filter

@Deprecated
public UserSearchParams.Builder filter(com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter)

Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9.

Parameters:

postProcessingFilter - a filter applied after search results are retrieved. Use this for more complex filter logic that can't be expressed in a UserFilter or other parameters.

Since:

v7.0

maxResults

@Deprecated
public UserSearchParams.Builder maxResults(Integer maxResults)

Deprecated. Use limitResults(int) instead.

Parameters:

maxResults - the maximum number of results to retrieve.

Since:

v7.0

limitResults

public UserSearchParams.Builder limitResults(int limit)

Parameters:

limit - the maximum number of results to retrieve. The maximum allowed is 100. If higher number is provided it will be set to 100 in resulting UserSearchParams.

Since:

v8.20

sorted

public UserSearchParams.Builder sorted(boolean sorted)

Parameters:

sorted - true to ensure results are sorted, false if results may be unsorted. Turning sorting off may have better performance.

Since:

v7.0

ignorePermissionCheck

public UserSearchParams.Builder ignorePermissionCheck(boolean ignorePermissionCheck)

Parameters:

ignorePermissionCheck - a flag indicating whether the permission checking has already been performed. If false (the default), the logged in user must have browser users permission to list users or else an empty list is always returned. If true, searches are not restricted by the logged in user's permissions.

Since:

v7.0

forceStrongConsistency

public UserSearchParams.Builder forceStrongConsistency(boolean forceStrongConsistency)

Parameters:

forceStrongConsistency - whether the search must avoid returning stale data. Use only if really necessary as it may cripple performance.

Since:

v9.0