org.kuali.rice.kew.docsearch
Interface DocumentSearchGenerator

All Known Implementing Classes:

DataDictionaryDocumentSearchCustomizer, StandardDocumentSearchGenerator

public interface DocumentSearchGenerator

TODO delyea - documentation

Author:

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

Field Summary

static int

DEFAULT_SEARCH_RESULT_CAP

Method Summary

DocSearchCriteriaDTO	clearSearch(DocSearchCriteriaDTO searchCriteria)
String	generateSearchSql(DocSearchCriteriaDTO searchCriteria)
int	getDocumentSearchResultSetLimit()
MessageMap	getMessageMap(DocSearchCriteriaDTO searchCriteria)
boolean	isProcessResultSet() This method returns if processResultSet should be called.
List<WorkflowServiceError>	performPreSearchConditions(String principalId, DocSearchCriteriaDTO searchCriteria)
List<DocSearchDTO>	processResultSet(Statement searchAttributeStatement, ResultSet resultSet, DocSearchCriteriaDTO searchCriteria) Deprecated. Removed as of version 0.9.3. Use processResultSet(java.sql.Statement, java.sql.ResultSet, DocSearchCriteriaDTO, String)
List<DocSearchDTO>	processResultSet(Statement searchAttributeStatement, ResultSet resultSet, DocSearchCriteriaDTO searchCriteria, String principalId) This method processes search results in the given resultSet into DocSearchDTO objects
void	setProcessResultSet(boolean isProcessResultSet)
void	setSearchingUser(String principalId)
List<WorkflowServiceError>	validateSearchableAttributes(DocSearchCriteriaDTO searchCriteria)

Field Detail

DEFAULT_SEARCH_RESULT_CAP

static final int DEFAULT_SEARCH_RESULT_CAP

See Also:

Constant Field Values

Method Detail

setSearchingUser

void setSearchingUser(String principalId)

performPreSearchConditions

List<WorkflowServiceError> performPreSearchConditions(String principalId,
                                                      DocSearchCriteriaDTO searchCriteria)

validateSearchableAttributes

List<WorkflowServiceError> validateSearchableAttributes(DocSearchCriteriaDTO searchCriteria)

generateSearchSql

String generateSearchSql(DocSearchCriteriaDTO searchCriteria)

processResultSet

List<DocSearchDTO> processResultSet(Statement searchAttributeStatement,
                                    ResultSet resultSet,
                                    DocSearchCriteriaDTO searchCriteria)
                                    throws SQLException

Deprecated. Removed as of version 0.9.3. Use processResultSet(java.sql.Statement, java.sql.ResultSet, DocSearchCriteriaDTO, String)

Throws:

SQLException

processResultSet

List<DocSearchDTO> processResultSet(Statement searchAttributeStatement,
                                    ResultSet resultSet,
                                    DocSearchCriteriaDTO searchCriteria,
                                    String principalId)
                                    throws SQLException

This method processes search results in the given resultSet into DocSearchDTO objects

Parameters:

searchAttributeStatement - - statement to use when fetching search attributes

resultSet - - resultSet containing data from document search main tables

searchCriteria - - criteria used to perform the search

principalId - - user who performed the search

Returns:

a list of DocSearchDTO objects (one for each route header id)

Throws:

SQLException

clearSearch

DocSearchCriteriaDTO clearSearch(DocSearchCriteriaDTO searchCriteria)

getDocumentSearchResultSetLimit

int getDocumentSearchResultSetLimit()

isProcessResultSet

boolean isProcessResultSet()

This method returns if processResultSet should be called.

Returns:

setProcessResultSet

void setProcessResultSet(boolean isProcessResultSet)

getMessageMap

MessageMap getMessageMap(DocSearchCriteriaDTO searchCriteria)