org.picketlink.idm.query

Interface IdentityQueryBuilder

All Known Implementing Classes:

DefaultQueryBuilder

public interface IdentityQueryBuilder

The IdentityQueryBuilder is responsible for creating IdentityQuery instances and also provide methods to create conditions, orderings, sorting, etc.

Instances of this class are obtained from the IdentityManager as follows:

      IdentityManager identityManager = getIdentityManager();

      // here we get the query builder
      IdentityQueryBuilder builder = identityManager.getQueryBuilder();

      // create a condition
      Condition condition = builder.equal(User.LOGIN_NAME, "john");

      // create a query for a specific identity type using the previously created condition
      IdentityQuery query = builder.createIdentityQuery(User.class).where(condition);

      // execute the query
      List result = query.getResultList();
 

Author:

Pedro Igor

Method Summary

Modifier and Type	Method and Description
Sort	asc(QueryParameter parameter) Create an ascending order for the given parameter.
Condition	between(QueryParameter parameter, Object x, Object y) Create a condition for testing whether the query parameter is between the given values.
<T extends IdentityType> IdentityQuery<T>	createIdentityQuery(Class<T> identityType) Create an IdentityQuery that can be used to query for IdentityType instances of a the given identityType.
Sort	desc(QueryParameter parameter) Create an descending order for the given parameter.
Condition	equal(QueryParameter parameter, Object value) Create a condition for testing the arguments for equality.
Condition	greaterThan(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is grater than the given value..
Condition	greaterThanOrEqualTo(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is grater than or equal to the given value..
Condition	in(QueryParameter parameter, Object... values) Create a condition for testing whether the query parameter is contained in a list of values.
Condition	lessThan(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is less than the given value..
Condition	lessThanOrEqualTo(QueryParameter parameter, Object x) Create a condition for testing whether the query parameter is less than or equal to the given value..
Condition	like(QueryParameter parameter, String pattern) Create a condition for testing the whether the query parameter satisfies the given pattern..

Method Detail

like

Condition like(QueryParameter parameter,
               String pattern)

Create a condition for testing the whether the query parameter satisfies the given pattern..

Parameters:

parameter - The query parameter.

pattern - The pattern to match.

Returns:

equal

Condition equal(QueryParameter parameter,
                Object value)

Create a condition for testing the arguments for equality.

Parameters:

parameter - The query parameter.

value - The value to compare.

Returns:

greaterThan

Condition greaterThan(QueryParameter parameter,
                      Object x)

Create a condition for testing whether the query parameter is grater than the given value..

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

greaterThanOrEqualTo

Condition greaterThanOrEqualTo(QueryParameter parameter,
                               Object x)

Create a condition for testing whether the query parameter is grater than or equal to the given value..

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

lessThan

Condition lessThan(QueryParameter parameter,
                   Object x)

Create a condition for testing whether the query parameter is less than the given value..

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

lessThanOrEqualTo

Condition lessThanOrEqualTo(QueryParameter parameter,
                            Object x)

Create a condition for testing whether the query parameter is less than or equal to the given value..

Parameters:

parameter - The query parameter.

x - The value to compare.

Returns:

between

Condition between(QueryParameter parameter,
                  Object x,
                  Object y)

Create a condition for testing whether the query parameter is between the given values.

Parameters:

parameter - The query parameter.

x - The first value.

x - The second value.

Returns:

in

Condition in(QueryParameter parameter,
             Object... values)

Create a condition for testing whether the query parameter is contained in a list of values.

Parameters:

parameter - The query parameter.

values - A list of values.

Returns:

asc

Sort asc(QueryParameter parameter)

Create an ascending order for the given parameter. Once created, you can use it to sort the results of a query.

Parameters:

parameter - The query parameter to sort.

Returns:

desc

Sort desc(QueryParameter parameter)

Create an descending order for the given parameter. Once created, you can use it to sort the results of a query.

Parameters:

parameter - The query parameter to sort.

Returns:

createIdentityQuery

<T extends IdentityType> IdentityQuery<T> createIdentityQuery(Class<T> identityType)

Create an IdentityQuery that can be used to query for IdentityType instances of a the given identityType.

Parameters:

identityType - The type to search. If you provide the IdentityType base interface any of its sub-types will be returned.

Returns: