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

static class

UserSearchParams.Builder

Field Summary

static UserSearchParams	ACTIVE_USERS_ALLOW_EMPTY_QUERY
static UserSearchParams	ACTIVE_USERS_IGNORE_EMPTY_QUERY

Constructor Summary

UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive)

Method Summary

boolean	allowEmptyQuery()
static UserSearchParams.Builder	builder()
boolean	includeActive()
boolean	includeInactive()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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)

Method Detail

allowEmptyQuery

public boolean allowEmptyQuery()

includeActive

public boolean includeActive()

includeInactive

public boolean includeInactive()

builder

public static UserSearchParams.Builder builder()