Package org.apache.archiva.redback.users
Interface UserQuery
-
- All Known Implementing Classes:
AbstractUserQuery
,JpaUserQuery
,LdapUserQuery
,SimpleUserQuery
public interface UserQuery
-
-
Field Summary
Fields Modifier and Type Field Description static Set<String>
ALLOWED_ORDER_FIELDS
static String
ORDER_BY_EMAIL
static String
ORDER_BY_FULLNAME
static String
ORDER_BY_USERNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getEmail()
Returns the case insensitive substring email criteria.long
getFirstResult()
Returns the index (zero based) of the first result to include.String
getFullName()
Returns the case insensitive substring full name criteria.long
getMaxResults()
Returns the maximum number of users to return.String
getOrderBy()
Returns the property used to order the results of this query.String
getUsername()
Returns the case insensitive substring user name criteria.boolean
isAscending()
Returns true if the results should be returned in ascending order.void
setAscending(boolean ascending)
Set this to true if the results should be returned in ascending order.void
setEmail(String email)
Sets the case insensitive substring email criteria.void
setFirstResult(int firstResult)
Sets the index (zero based) of the first result to include.void
setFullName(String fullName)
Sets the case insensitive substring full name criteria.void
setMaxResults(int maxResults)
Sets the maximum number of users to return.void
setOrderBy(String orderBy)
Sets the property used to order the results of this query.void
setUsername(String userName)
Sets the case insensitive substring user name criteria.
-
-
-
Field Detail
-
ORDER_BY_USERNAME
static final String ORDER_BY_USERNAME
- See Also:
- Constant Field Values
-
ORDER_BY_FULLNAME
static final String ORDER_BY_FULLNAME
- See Also:
- Constant Field Values
-
ORDER_BY_EMAIL
static final String ORDER_BY_EMAIL
- See Also:
- Constant Field Values
-
ALLOWED_ORDER_FIELDS
static final Set<String> ALLOWED_ORDER_FIELDS
-
-
Method Detail
-
getUsername
String getUsername()
Returns the case insensitive substring user name criteria.- Returns:
- the username criteria.
-
setUsername
void setUsername(String userName)
Sets the case insensitive substring user name criteria.- Parameters:
userName
- the username criteria
-
getFullName
String getFullName()
Returns the case insensitive substring full name criteria.- Returns:
- the username criteria.
-
setFullName
void setFullName(String fullName)
Sets the case insensitive substring full name criteria.- Parameters:
fullName
- the full name criteria
-
getEmail
String getEmail()
Returns the case insensitive substring email criteria.- Returns:
- the email criteria.
-
setEmail
void setEmail(String email)
Sets the case insensitive substring email criteria.- Parameters:
email
- the email criteria
-
getFirstResult
long getFirstResult()
Returns the index (zero based) of the first result to include. Useful for paging.- Returns:
- the first index
-
setFirstResult
void setFirstResult(int firstResult)
Sets the index (zero based) of the first result to include. Useful for paging.- Parameters:
firstResult
- the first index
-
getMaxResults
long getMaxResults()
Returns the maximum number of users to return.- Returns:
- the maximum number of users to return.
-
setMaxResults
void setMaxResults(int maxResults)
Sets the maximum number of users to return.- Parameters:
maxResults
- the maximum number of users to return.
-
getOrderBy
String getOrderBy()
Returns the property used to order the results of this query. This is one ofORDER_BY_USERNAME
,ORDER_BY_FULLNAME
orORDER_BY_EMAIL
.- Returns:
- the order property.
-
setOrderBy
void setOrderBy(String orderBy)
Sets the property used to order the results of this query. This is one ofORDER_BY_USERNAME
,ORDER_BY_FULLNAME
orORDER_BY_EMAIL
.- Parameters:
orderBy
- the order property.
-
isAscending
boolean isAscending()
Returns true if the results should be returned in ascending order.- Returns:
- ascending
-
setAscending
void setAscending(boolean ascending)
Set this to true if the results should be returned in ascending order.- Parameters:
ascending
- true if the results should be returned in ascending
-
-