org.picketlink.idm.query

Interface IdentityQuery<T extends IdentityType>

public interface IdentityQuery<T extends IdentityType>

Unified identity query API

Author:

Shane Bryzak

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.

Method Detail

setOffset

IdentityQuery<T> setOffset(int offset)

setLimit

IdentityQuery<T> setLimit(int limit)

setSortParameters

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

Parameters:

sortParameters - parameters to specify sort criteria

Returns:

this query

getSortParameters

QueryParameter[] getSortParameters()

See Also:

setSortParameters(QueryParameter...)

setSortAscending

IdentityQuery<T> setSortAscending(boolean sortAscending)

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

Parameters:

sortAscending - to specify if sorting will be ascending or descending

Returns:

this query

isSortAscending

boolean isSortAscending()

Returns:

true if sorting will be ascending

See Also:

setSortAscending(boolean)

setParameter

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

getIdentityType

Class<T> getIdentityType()

getParameters

Map<QueryParameter,Object[]> getParameters()

getParameter

Object[] getParameter(QueryParameter queryParameter)

getParameters

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

getOffset

int getOffset()

getLimit

int getLimit()

getResultList

List<T> getResultList()

getResultCount

int getResultCount()

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

Returns:

count of all query results