Package org.kuali.rice.kew.docsearch

Interface DocumentSearchCriteriaProcessor

All Known Implementing Classes:

DocumentSearchCriteriaProcessorKEWAdapter

public interface DocumentSearchCriteriaProcessor

Used by the document search helper to produce rows to render for the document search screen.

Author:

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

Method Summary

Modifier and Type	Method	Description
List<org.kuali.rice.kns.web.ui.Row>	getRows(DocumentType documentType, List<org.kuali.rice.kns.web.ui.Row> defaultRows, boolean detailed, boolean superSearch)	Constructs the list of rows and fields to display in the lookup criteria section of the document search screen.

Method Details

getRows

List<org.kuali.rice.kns.web.ui.Row> getRows(DocumentType documentType,
 List<org.kuali.rice.kns.web.ui.Row> defaultRows,
 boolean detailed,
 boolean superSearch)

Constructs the list of rows and fields to display in the lookup criteria section of the document search screen. The documentType parameter passed to this method will generally be supplied in cases where the document type name was supplied to the lookup via a query parameter or when refreshing the criteria after making a change to it (like the user doing a document type lookup to fill in the value and then returning it back to the document search).

This method should look at the given document type (if there is one) to determine if there are any custom rows to render for that document type. It should also look at the request for detailed and super user search and adjust the rows accordingly for either of those conditions.

Parameters:

documentType - supplies the document type in use on this search if one is specified, will be null otherwise

defaultRows - the default set of rows that are supplied from the data dictionary for the document search

detailed - indicates whether or not a detailed search has been requested

superSearch - indicates whether or not a super user search has been requested

Returns:

the rows to render is the criteria section of the document search.