org.kuali.rice.krad.dao
Interface LookupDao

All Known Implementing Classes:

LookupDaoJpa, LookupDaoOjb, LookupDaoProxy

public interface LookupDao

Defines basic methods that Lookup Dao's must provide

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

boolean	createCriteria(Object example, String searchValue, String propertyName, boolean caseInsensitive, boolean treatWildcardsAndOperatorsAsLiteral, Object criteria) Create OJB criteria based on business object, search field and value
boolean	createCriteria(Object example, String searchValue, String propertyName, Object criteria) Create OJB criteria based on business object, search field and value
<T> Collection<T>	findCollectionBySearchHelper(Class<T> businessObjectClass, Map<String,String> formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly) Retrieves a collection of objects for the businessObjectClass based on the other information passed into the method.
<T> Collection<T>	findCollectionBySearchHelper(Class<T> businessObjectClass, Map<String,String> formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly, Integer searchResultsLimit) Retrieves a collection of objects for the businessObjectClass based on the other information passed into the method.
Long	findCountByMap(Object example, Map<String,String> formProps) Returns a count of objects based on the given search parameters.
<T> T	findObjectByMap(T example, Map<String,String> formProps) Retrieves a Object based on the search criteria, which should uniquely identify a record.

Method Detail

findCollectionBySearchHelper

<T> Collection<T> findCollectionBySearchHelper(Class<T> businessObjectClass,
                                               Map<String,String> formProps,
                                               boolean unbounded,
                                               boolean usePrimaryKeyValuesOnly)

Retrieves a collection of objects for the businessObjectClass based on the other information passed into the method.

Parameters:

businessObjectClass - - business object being queried on

formProps - - map of form properties

unbounded - - indicates if the search should be unbounded

usePrimaryKeyValuesOnly - - indicates if only primary key values should be used

Returns:

Object returned from the search

findCollectionBySearchHelper

<T> Collection<T> findCollectionBySearchHelper(Class<T> businessObjectClass,
                                               Map<String,String> formProps,
                                               boolean unbounded,
                                               boolean usePrimaryKeyValuesOnly,
                                               Integer searchResultsLimit)

Retrieves a collection of objects for the businessObjectClass based on the other information passed into the method.

Parameters:

businessObjectClass - - business object being queried on

formProps - - map of form properties

unbounded - - indicates if the search should be unbounded

usePrimaryKeyValuesOnly - - indicates if only primary key values should be used

searchResultsLimit - - used to limit the number of items returned

Returns:

Object returned from the search

findObjectByMap

<T> T findObjectByMap(T example,
                      Map<String,String> formProps)

Retrieves a Object based on the search criteria, which should uniquely identify a record.

Returns:

Object returned from the search

findCountByMap

Long findCountByMap(Object example,
                    Map<String,String> formProps)

Returns a count of objects based on the given search parameters.

Returns:

Long returned from the search

createCriteria

boolean createCriteria(Object example,
                       String searchValue,
                       String propertyName,
                       Object criteria)

Create OJB criteria based on business object, search field and value

Returns:

true if the criteria is created successfully; otherwise, return false

createCriteria

boolean createCriteria(Object example,
                       String searchValue,
                       String propertyName,
                       boolean caseInsensitive,
                       boolean treatWildcardsAndOperatorsAsLiteral,
                       Object criteria)

Create OJB criteria based on business object, search field and value

Returns:

true if the criteria is created successfully; otherwise, return false