org.codehaus.plexus.redback.users
Class AbstractUserQuery

java.lang.Object
  org.codehaus.plexus.redback.users.AbstractUserQuery

All Implemented Interfaces:

UserQuery

public abstract class AbstractUserQuery
extends java.lang.Object
implements UserQuery

Abstract Implementation of UserQuery. Intended to be subclassed by UserManager providers.

Field Summary

Fields inherited from interface org.codehaus.plexus.redback.users.UserQuery

ALLOWED_ORDER_FIELDS, ORDER_BY_EMAIL, ORDER_BY_FULLNAME, ORDER_BY_USERNAME

Constructor Summary

AbstractUserQuery()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserQuery

public AbstractUserQuery()

Method Detail

getUsername

public java.lang.String getUsername()

Description copied from interface: UserQuery

Returns the case insensitive substring user name criteria.

Specified by:

getUsername in interface UserQuery

Returns:

the username criteria.

setUsername

public void setUsername(java.lang.String userName)

Description copied from interface: UserQuery

Sets the case insensitive substring user name criteria.

Specified by:

setUsername in interface UserQuery

Parameters:

userName - the username criteria

getFullName

public java.lang.String getFullName()

Description copied from interface: UserQuery

Returns the case insensitive substring full name criteria.

Specified by:

getFullName in interface UserQuery

Returns:

the username criteria.

setFullName

public void setFullName(java.lang.String fullName)

Description copied from interface: UserQuery

Sets the case insensitive substring full name criteria.

Specified by:

setFullName in interface UserQuery

Parameters:

fullName - the full name criteria

getEmail

public java.lang.String getEmail()

Description copied from interface: UserQuery

Returns the case insensitive substring email criteria.

Specified by:

getEmail in interface UserQuery

Returns:

the email criteria.

setEmail

public void setEmail(java.lang.String email)

Description copied from interface: UserQuery

Sets the case insensitive substring email criteria.

Specified by:

setEmail in interface UserQuery

Parameters:

email - the email criteria

getFirstResult

public long getFirstResult()

Description copied from interface: UserQuery

Returns the index (zero based) of the first result to include. Useful for paging.

Specified by:

getFirstResult in interface UserQuery

Returns:

the first index

setFirstResult

public void setFirstResult(int firstResult)

Description copied from interface: UserQuery

Sets the index (zero based) of the first result to include. Useful for paging.

Specified by:

setFirstResult in interface UserQuery

Parameters:

firstResult - the first index

getMaxResults

public long getMaxResults()

Description copied from interface: UserQuery

Returns the maximum number of users to return.

Specified by:

getMaxResults in interface UserQuery

Returns:

the maxinum number of users to return.

setMaxResults

public void setMaxResults(int maxResults)

Description copied from interface: UserQuery

Sets the maximum number of users to return.

Specified by:

setMaxResults in interface UserQuery

Parameters:

maxResults - the maxinum number of users to return.

getOrderBy

public java.lang.String getOrderBy()

Description copied from interface: UserQuery

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

Specified by:

getOrderBy in interface UserQuery

Returns:

the order property.

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Description copied from interface: UserQuery

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

Specified by:

setOrderBy in interface UserQuery

Parameters:

orderBy - the order property.

isAscending

public boolean isAscending()

Description copied from interface: UserQuery

Returns true if the results should be returned in ascending order.

Specified by:

isAscending in interface UserQuery

Returns:

ascending

setAscending

public void setAscending(boolean ascending)

Description copied from interface: UserQuery

Set this to true if the results should be returned in ascending order.

Specified by:

setAscending in interface UserQuery

Parameters:

ascending - true if the results should be returned in ascending