Interface UserSearchCriteria
-
public interface UserSearchCriteria
Criteria in searching of user details.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
UserSearchCriteria.Criterion
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UserSearchCriteria
and()
Appends a criteria conjonction.boolean
isEmpty()
Is this criteria empty?UserSearchCriteria
onDomainId(String domainId)
The users must be part of the specified domain or must have the administration priviledges (the administrators are visible by anyone in the platform in order to be contacted).UserSearchCriteria
onGroupIds(String... groupIds)
The users must be part of the specified user groups.UserSearchCriteria
onName(String name)
The users must have their firstname or their lastname matching the specified pattern on the name.UserSearchCriteria
onUserIds(String... userIds)
The user identifiers must match the specified ones.UserSearchCriteria
or()
Appends a criteria disjonction.
-
-
-
Method Detail
-
and
UserSearchCriteria and()
Appends a criteria conjonction.- Returns:
- the criteria enriched with a conjonction. The conjonction will be applied with the last added criterion and the next one.
-
onDomainId
UserSearchCriteria onDomainId(String domainId)
The users must be part of the specified domain or must have the administration priviledges (the administrators are visible by anyone in the platform in order to be contacted).- Parameters:
domainId
- the unique identifier of the domain.- Returns:
- the criteria enriched with a criterion on the domain.
-
onGroupIds
UserSearchCriteria onGroupIds(String... groupIds)
The users must be part of the specified user groups.- Parameters:
groupIds
- the unique identifier of the groups.- Returns:
- the criteria enriched with a criterion on the user groups.
-
onName
UserSearchCriteria onName(String name)
The users must have their firstname or their lastname matching the specified pattern on the name.- Parameters:
name
- a pattern on user name.- Returns:
- the criteria enriched with a criterion on the user name.
-
onUserIds
UserSearchCriteria onUserIds(String... userIds)
The user identifiers must match the specified ones.- Parameters:
userIds
- the user identifiers.- Returns:
- the criteria enriched with a criterion on the user identifiers.
-
or
UserSearchCriteria or()
Appends a criteria disjonction.- Returns:
- the criteria enriched with a disjonction. The disjonction will be applied with the last added criterion and the next one.
-
isEmpty
boolean isEmpty()
Is this criteria empty?- Returns:
- true if this criteria has no criterion, false otherwise.
-
-