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)

UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds)

Method Summary

boolean	allowEmptyQuery()
static UserSearchParams.Builder	builder()
static UserSearchParams.Builder	builder(UserSearchParams prototype)
boolean	canMatchEmail()
boolean	equals(Object o)
Set<Long>	getProjectIds()
UserFilter	getUserFilter()
int	hashCode()
boolean	includeActive()
boolean	includeInactive()

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)

UserSearchParams

public UserSearchParams(boolean allowEmptyQuery,
                        boolean includeActive,
                        boolean includeInactive,
                        boolean canMatchEmail,
                        UserFilter userFilter,
                        Set<Long> projectIds)

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

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)