Package com.atlassian.confluence.internal.user

Class UserSearchRequest

java.lang.Object

com.atlassian.confluence.internal.user.SearchRequest

com.atlassian.confluence.internal.user.UserSearchRequest

public class UserSearchRequest
extends SearchRequest

Search for users.

Supports simple search, with getSearchTerm(), and advanced search, with getUsernameTerm(), getEmailTerm() and getFullnameTerm(). Note that emailTerm will only be used when searching if isShowEmail() is enabled.

All term fields support comma delimited strings with wildcard prefixes and suffixes.

Since:

5.9

Method Summary

Modifier and Type	Method	Description
static UserSearchRequestBuilder	builder()
String	getEmailTerm()
String	getFullnameTerm()
String	getSearchTerm()
String	getUsernameTerm()
boolean	isShowEmail()
boolean	isSimpleSearch()

Methods inherited from class com.atlassian.confluence.internal.user.SearchRequest

isShowUnlicensedUsers

Methods inherited from class java.lang.Object

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

Method Details

isSimpleSearch

public boolean isSimpleSearch()

getSearchTerm

public String getSearchTerm()

getUsernameTerm

public String getUsernameTerm()

getEmailTerm

public String getEmailTerm()

getFullnameTerm

public String getFullnameTerm()

isShowEmail

public boolean isShowEmail()

builder

public static UserSearchRequestBuilder builder()