Class FindUsersRequest
- Object
-
- PagedRequest
-
- FindUsersRequest
-
- All Implemented Interfaces:
Serializable
public class FindUsersRequest extends PagedRequest
The search criteria for users.Only parameters that are specified in this request and have not
null
values are used for filtering. All other parameters are ignored.The returned users satisfy all constraints that are specified in this search criteria.
By default a result containing 1000 users is returned.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FindUsersRequest.Builder
-
Field Summary
-
Fields inherited from class PagedRequest
countLimit, limit, offset
-
-
Constructor Summary
Constructors Constructor Description FindUsersRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FindUsersRequest.Builder
builder()
protected boolean
canEqual(Object other)
boolean
equals(Object o)
UUID
getGroupId()
The ID of the group the searched users should belong to.String
getName()
The name of the user.Set<NameSearchField>
getNameSearchFields()
The user fields that will be searched for occurrences of thename
parameter.NameSearchField
getSortField()
SortOrder
getSortOrder()
List<String>
getUserIds()
The IDs of the users.int
hashCode()
boolean
isIncludeDisabled()
Whether disabled users should be included in the search results.boolean
isOnlyLoggedIn()
Whether only currently logged in users should be returned.void
setGroupId(UUID groupId)
The ID of the group the searched users should belong to.void
setIncludeDisabled(boolean includeDisabled)
Whether disabled users should be included in the search results.void
setName(String name)
The name of the user.void
setNameSearchFields(Set<NameSearchField> nameSearchFields)
The user fields that will be searched for occurrences of thename
parameter.void
setOnlyLoggedIn(boolean onlyLoggedIn)
Whether only currently logged in users should be returned.void
setSortField(NameSearchField sortField)
void
setSortOrder(SortOrder sortOrder)
void
setUserIds(List<String> userIds)
The IDs of the users.String
toString()
-
Methods inherited from class PagedRequest
getCountLimit, getLimit, getOffset, isPagingActive, setCountLimit, setLimit, setOffset
-
-
-
-
Method Detail
-
builder
public static FindUsersRequest.Builder builder()
-
getUserIds
public List<String> getUserIds()
The IDs of the users.
-
getName
public String getName()
The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.
-
getNameSearchFields
public Set<NameSearchField> getNameSearchFields()
The user fields that will be searched for occurrences of thename
parameter.It defaults to
USERNAME
,FIRSTNAME
,LASTNAME
,FIRSTNAME_LASTNAME
andLASTNAME_FIRSTNAME
.
-
getGroupId
public UUID getGroupId()
The ID of the group the searched users should belong to.
-
isOnlyLoggedIn
public boolean isOnlyLoggedIn()
Whether only currently logged in users should be returned.
-
isIncludeDisabled
public boolean isIncludeDisabled()
Whether disabled users should be included in the search results.
-
getSortOrder
public SortOrder getSortOrder()
-
getSortField
public NameSearchField getSortField()
-
setUserIds
public void setUserIds(List<String> userIds)
The IDs of the users.
-
setName
public void setName(String name)
The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.
-
setNameSearchFields
public void setNameSearchFields(Set<NameSearchField> nameSearchFields)
The user fields that will be searched for occurrences of thename
parameter.It defaults to
USERNAME
,FIRSTNAME
,LASTNAME
,FIRSTNAME_LASTNAME
andLASTNAME_FIRSTNAME
.
-
setGroupId
public void setGroupId(UUID groupId)
The ID of the group the searched users should belong to.
-
setOnlyLoggedIn
public void setOnlyLoggedIn(boolean onlyLoggedIn)
Whether only currently logged in users should be returned.
-
setIncludeDisabled
public void setIncludeDisabled(boolean includeDisabled)
Whether disabled users should be included in the search results.
-
setSortOrder
public void setSortOrder(SortOrder sortOrder)
-
setSortField
public void setSortField(NameSearchField sortField)
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classPagedRequest
-
canEqual
protected boolean canEqual(Object other)
- Overrides:
canEqual
in classPagedRequest
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classPagedRequest
-
toString
public String toString()
- Overrides:
toString
in classPagedRequest
-
-