org.picketlink.idm.query.internal

Class DefaultIdentityQuery<T extends IdentityType>

java.lang.Object

org.picketlink.idm.query.internal.DefaultIdentityQuery<T>

Type Parameters:

T -

All Implemented Interfaces:

IdentityQuery<T>

public class DefaultIdentityQuery<T extends IdentityType>
extends Object
implements IdentityQuery<T>

Default IdentityQuery implementation.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
DefaultIdentityQuery(IdentityContext context, Class<T> identityType, StoreSelector storeSelector)

Method Summary

Methods

Modifier and Type	Method and Description
Class<T>	getIdentityType()
int	getLimit()
int	getOffset()
Object[]	getParameter(QueryParameter queryParameter)
Map<QueryParameter,Object[]>	getParameters()
Map<QueryParameter,Object[]>	getParameters(Class<?> type)
int	getResultCount() Count of all query results.
List<T>	getResultList()
QueryParameter[]	getSortParameters()
boolean	isSortAscending()
IdentityQuery<T>	setLimit(int limit)
IdentityQuery<T>	setOffset(int offset)
IdentityQuery<T>	setParameter(QueryParameter param, Object... value)
IdentityQuery<T>	setSortAscending(boolean sortAscending) Specify if sorting will be ascending (true) or descending (false)
IdentityQuery<T>	setSortParameters(QueryParameter... sortParameters) Parameters used to sort the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIdentityQuery

public DefaultIdentityQuery(IdentityContext context,
                    Class<T> identityType,
                    StoreSelector storeSelector)

Method Detail

setParameter

public IdentityQuery<T> setParameter(QueryParameter param,
                            Object... value)

Specified by:

setParameter in interface IdentityQuery<T extends IdentityType>

getIdentityType

public Class<T> getIdentityType()

Specified by:

getIdentityType in interface IdentityQuery<T extends IdentityType>

getParameters

public Map<QueryParameter,Object[]> getParameters()

Specified by:

getParameters in interface IdentityQuery<T extends IdentityType>

getParameter

public Object[] getParameter(QueryParameter queryParameter)

Specified by:

getParameter in interface IdentityQuery<T extends IdentityType>

getParameters

public Map<QueryParameter,Object[]> getParameters(Class<?> type)

Specified by:

getParameters in interface IdentityQuery<T extends IdentityType>

getLimit

public int getLimit()

Specified by:

getLimit in interface IdentityQuery<T extends IdentityType>

getOffset

public int getOffset()

Specified by:

getOffset in interface IdentityQuery<T extends IdentityType>

getSortParameters

public QueryParameter[] getSortParameters()

Specified by:

getSortParameters in interface IdentityQuery<T extends IdentityType>

See Also:

IdentityQuery.setSortParameters(QueryParameter...)

isSortAscending

public boolean isSortAscending()

Specified by:

isSortAscending in interface IdentityQuery<T extends IdentityType>

Returns:

true if sorting will be ascending

See Also:

IdentityQuery.setSortAscending(boolean)

getResultList

public List<T> getResultList()

Specified by:

getResultList in interface IdentityQuery<T extends IdentityType>

getResultCount

public int getResultCount()

Description copied from interface: IdentityQuery

Count of all query results. It takes into account query parameters, but it doesn't take into account pagination parameter like offset and limit

Specified by:

getResultCount in interface IdentityQuery<T extends IdentityType>

Returns:

count of all query results

setOffset

public IdentityQuery<T> setOffset(int offset)

Specified by:

setOffset in interface IdentityQuery<T extends IdentityType>

setLimit

public IdentityQuery<T> setLimit(int limit)

Specified by:

setLimit in interface IdentityQuery<T extends IdentityType>

setSortParameters

public IdentityQuery<T> setSortParameters(QueryParameter... sortParameters)

Parameters used to sort the results. First parameter has biggest priority. For example: setSortParameter(User.LAST_NAME, User.FIRST_NAME) means that results will be sorted primarily by lastName and firstName will be used to sort only records with same lastName

Specified by:

setSortParameters in interface IdentityQuery<T extends IdentityType>

Parameters:

sortParameters - parameters to specify sort criteria

Returns:

this query

setSortAscending

public IdentityQuery<T> setSortAscending(boolean sortAscending)

Description copied from interface: IdentityQuery

Specify if sorting will be ascending (true) or descending (false)

Specified by:

setSortAscending in interface IdentityQuery<T extends IdentityType>

Parameters:

sortAscending - to specify if sorting will be ascending or descending

Returns:

this query