org.codehaus.plexus.redback.users
Interface UserQuery

All Known Implementing Classes:

AbstractUserQuery

public interface UserQuery

Field Summary

static java.util.Set	ALLOWED_ORDER_FIELDS
static java.lang.String	ORDER_BY_EMAIL
static java.lang.String	ORDER_BY_FULLNAME
static java.lang.String	ORDER_BY_USERNAME

Method Summary

java.lang.String	getEmail() Returns the case insensitive substring email criteria.
long	getFirstResult() Returns the index (zero based) of the first result to include.
java.lang.String	getFullName() Returns the case insensitive substring full name criteria.
long	getMaxResults() Returns the maximum number of users to return.
java.lang.String	getOrderBy() Returns the property used to order the results of this query.
java.lang.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(java.lang.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(java.lang.String fullName) Sets the case insensitive substring full name criteria.
void	setMaxResults(int maxResults) Sets the maximum number of users to return.
void	setOrderBy(java.lang.String orderBy) Sets the property used to order the results of this query.
void	setUsername(java.lang.String userName) Sets the case insensitive substring user name criteria.

Field Detail

ORDER_BY_USERNAME

static final java.lang.String ORDER_BY_USERNAME

See Also:

Constant Field Values

ORDER_BY_FULLNAME

static final java.lang.String ORDER_BY_FULLNAME

See Also:

Constant Field Values

ORDER_BY_EMAIL

static final java.lang.String ORDER_BY_EMAIL

See Also:

Constant Field Values

ALLOWED_ORDER_FIELDS

static final java.util.Set ALLOWED_ORDER_FIELDS

Method Detail

getUsername

java.lang.String getUsername()

Returns the case insensitive substring user name criteria.

Returns:

the username criteria.

setUsername

void setUsername(java.lang.String userName)

Sets the case insensitive substring user name criteria.

Parameters:

userName - the username criteria

getFullName

java.lang.String getFullName()

Returns the case insensitive substring full name criteria.

Returns:

the username criteria.

setFullName

void setFullName(java.lang.String fullName)

Sets the case insensitive substring full name criteria.

Parameters:

fullName - the full name criteria

getEmail

java.lang.String getEmail()

Returns the case insensitive substring email criteria.

Returns:

the email criteria.

setEmail

void setEmail(java.lang.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 maxinum number of users to return.

setMaxResults

void setMaxResults(int maxResults)

Sets the maximum number of users to return.

Parameters:

maxResults - the maxinum number of users to return.

getOrderBy

java.lang.String getOrderBy()

Returns the property used to order the results of this query. This is one of ORDER_BY_USERNAME, ORDER_BY_FULLNAME or ORDER_BY_EMAIL.

Returns:

the order property.

setOrderBy

void setOrderBy(java.lang.String orderBy)

Sets the property used to order the results of this query. This is one of ORDER_BY_USERNAME, ORDER_BY_FULLNAME or ORDER_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