org.kuali.student.r2.common.criteria

Interface CriteriaLookupService

All Known Implementing Classes:

CriteriaLookupServiceImpl

public interface CriteriaLookupService

Method Summary

Methods

Modifier and Type	Method and Description
<T> GenericQueryResults<List<String>>	genericLookup(Class<T> queryClass, QueryByCriteria criteria, List<String> fields) Looks up the requested field of a type based on a query criteria.
<T> GenericQueryResults<List<String>>	genericLookup(Class<T> queryClass, QueryByCriteria criteria, LookupCustomizer<T> customizer, List<String> fields) Looks up the requested field of a type based on a query criteria.
<T> GenericQueryResults<T>	lookup(Class<T> queryClass, QueryByCriteria criteria) Looks up a type based on a query criteria.
<T> GenericQueryResults<T>	lookup(Class<T> queryClass, QueryByCriteria criteria, LookupCustomizer<T> customizer) Looks up a type based on a query criteria.
<T> GenericQueryResults<String>	lookupIds(Class<T> queryClass, QueryByCriteria criteria) Looks up the id of a type based on a query criteria.
<T> GenericQueryResults<String>	lookupIds(Class<T> queryClass, QueryByCriteria criteria, LookupCustomizer<T> customizer) Looks up the id of a type based on a query criteria.

Method Detail

lookup

<T> GenericQueryResults<T> lookup(Class<T> queryClass,
                                QueryByCriteria criteria)

Looks up a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null

lookup

<T> GenericQueryResults<T> lookup(Class<T> queryClass,
                                QueryByCriteria criteria,
                                LookupCustomizer<T> customizer)

Looks up a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null

lookupIds

<T> GenericQueryResults<String> lookupIds(Class<T> queryClass,
                                        QueryByCriteria criteria)

Looks up the id of a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null

lookupIds

<T> GenericQueryResults<String> lookupIds(Class<T> queryClass,
                                        QueryByCriteria criteria,
                                        LookupCustomizer<T> customizer)

Looks up the id of a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null

genericLookup

<T> GenericQueryResults<List<String>> genericLookup(Class<T> queryClass,
                                                  QueryByCriteria criteria,
                                                  List<String> fields)

Looks up the requested field of a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

fields - the field of the query class to lookup

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null

genericLookup

<T> GenericQueryResults<List<String>> genericLookup(Class<T> queryClass,
                                                  QueryByCriteria criteria,
                                                  LookupCustomizer<T> customizer,
                                                  List<String> fields)

Looks up the requested field of a type based on a query criteria.

Type Parameters:

T - the type that is being looked up.

Parameters:

queryClass - the class to lookup

criteria - the criteria to lookup against. cannot be null.

fields - the field of the query class to lookup

Returns:

the results. will never be null.

Throws:

IllegalArgumentException - if the criteria is null