org.kuali.rice.krad.service
Interface LookupService

All Known Implementing Classes:

LookupServiceImpl

public interface LookupService

Provides search capabilities for the lookup framework. This service is primarily intended for internal use by the lookup framework. Client code should preferably invoke DataObjectService.findMatching(Class, org.kuali.rice.core.api.criteria.QueryByCriteria) passing the appropriate criteria.

Author:

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

Method Summary

boolean	allPrimaryKeyValuesPresentAndNotWildcard(Class<?> boClass, Map<String,String> formProps)
<T> Collection<T>	findCollectionBySearch(Class<T> type, Map<String,String> formProps) Returns a collection of objects based on the given search parameters.
<T> Collection<T>	findCollectionBySearchHelper(Class<T> type, Map<String,String> formProperties, boolean unbounded) This version of findCollectionBySearchHelper is needed for version compatibility.
<T> Collection<T>	findCollectionBySearchHelper(Class<T> type, Map<String,String> formProperties, boolean unbounded, Integer searchResultsLimit) Deprecated. please use findCollectionBySearchHelper(Class, java.util.Map, java.util.List, boolean, Integer) instead
<T> Collection<T>	findCollectionBySearchHelper(Class<T> type, Map<String,String> formProperties, List<String> wildcardAsLiteralPropertyNames, boolean unbounded, Integer searchResultsLimit) Returns a collection of objects based on the given search parameters.
<T> Collection<T>	findCollectionBySearchUnbounded(Class<T> type, Map<String,String> formProps) Returns a collection of objects based on the given search parameters.
<T> T	findObjectBySearch(Class<T> type, Map<String,String> formProps) Retrieves an Object based on the search criteria, which should uniquely identify a record.

Method Detail

findCollectionBySearchUnbounded

<T> Collection<T> findCollectionBySearchUnbounded(Class<T> type,
                                                  Map<String,String> formProps)

Returns a collection of objects based on the given search parameters. Will not limit results, so the returned Collection could be huge.

Parameters:

type - the type of the object for which to search

formProps - a map of attributes against which to query

Returns:

an unbounded collection of results from the search

findCollectionBySearch

<T> Collection<T> findCollectionBySearch(Class<T> type,
                                         Map<String,String> formProps)

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

Returns:

Collection returned from the search

findCollectionBySearchHelper

<T> Collection<T> findCollectionBySearchHelper(Class<T> type,
                                               Map<String,String> formProperties,
                                               boolean unbounded)

This version of findCollectionBySearchHelper is needed for version compatibility. It allows executeSearch to behave the same way as it did prior to 2.3. In the LookupDao, the value for searchResultsLimit will be retrieved from the KNS version of LookupUtils in the LookupDao.

Since:

2.3

findCollectionBySearchHelper

@Deprecated
<T> Collection<T> findCollectionBySearchHelper(Class<T> type,
                                                          Map<String,String> formProperties,
                                                          boolean unbounded,
                                                          Integer searchResultsLimit)

Deprecated. please use findCollectionBySearchHelper(Class, java.util.Map, java.util.List, boolean, Integer) instead

Parameters:

type - class name of the data object on which the lookup is performed

formProperties - Map of search criteria properties obtained from the lookup form

unbounded - determines if search limit used

searchResultsLimit - search limit value

Returns:

Collection of items found

findCollectionBySearchHelper

<T> Collection<T> findCollectionBySearchHelper(Class<T> type,
                                               Map<String,String> formProperties,
                                               List<String> wildcardAsLiteralPropertyNames,
                                               boolean unbounded,
                                               Integer searchResultsLimit)

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

This version of findCollectionBySearchHelper further isolates the UIFramework from the LookupService and should be used instead of the deprecated version.

Parameters:

type - class name of the data object on which the lookup is performed

formProperties - Map of search criteria properties obtained from the lookup form

wildcardAsLiteralPropertyNames - List of property names with wildcards disabled

unbounded - determines if search limit used

searchResultsLimit - search limit value

Returns:

Collection of items found

findObjectBySearch

<T> T findObjectBySearch(Class<T> type,
                         Map<String,String> formProps)

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

Returns:

Object returned from the search

allPrimaryKeyValuesPresentAndNotWildcard

boolean allPrimaryKeyValuesPresentAndNotWildcard(Class<?> boClass,
                                                 Map<String,String> formProps)