org.kuali.rice.kns.lookup

Interface LookupResultsSupportStrategyService

All Known Implementing Classes:

DataDictionaryLookupResultsSupportStrategy, PersistableBusinessObjectLookupResultsSupportStrategyImpl

public interface LookupResultsSupportStrategyService

Contract for strategies which can help LokoupResultsService with aspects (mainly id generation and result lookup) of multi value lookup support

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getLookupIdForBusinessObject(BusinessObject businessObject) Generates a String id which is used as an id on a checkbox for result rows returning the business object in a multiple value lookup
boolean	qualifiesForStrategy(Class<? extends BusinessObject> boClass) Determines if the given class is supported by this strategy
<T extends BusinessObject> Collection<T>	retrieveSelectedResultBOs(Class<T> boClass, Set<String> lookupIds) Returns a list of BOs that were selected.

Method Detail

retrieveSelectedResultBOs

<T extends BusinessObject> Collection<T> retrieveSelectedResultBOs(Class<T> boClass,
                                                                 Set<String> lookupIds)
                                                               throws Exception

Returns a list of BOs that were selected. This implementation makes an attempt to retrieve all BOs with the given object IDs, unless they have been deleted or the object ID changed. Since data may have changed since the search, the returned BOs may not match the criteria used to search.

Parameters:

lookupResultsSequenceNumber - the sequence number identifying the lookup results in the database

boClass - the class of the business object to retrieve

personId - the id of the principal performing this search

lookupResultsService - an implementation of the lookupResultsService to do some of the dirty work...

Returns:

a Collection of retrieved BusinessObjects

Throws:

Exception - if anything goes wrong...well, just blow up, okay?

getLookupIdForBusinessObject

String getLookupIdForBusinessObject(BusinessObject businessObject)

Generates a String id which is used as an id on a checkbox for result rows returning the business object in a multiple value lookup

Parameters:

businessObject - the lookup to generate an id for

Returns:

the String id

qualifiesForStrategy

boolean qualifiesForStrategy(Class<? extends BusinessObject> boClass)

Determines if the given class is supported by this strategy

Parameters:

boClass - the class to test the determination on

Returns:

true if this strategy supports it, false otherwise