org.kuali.rice.kew.docsearch.service.impl
Class DocumentSearchServiceImpl

java.lang.Object
  org.kuali.rice.kew.docsearch.service.impl.DocumentSearchServiceImpl

All Implemented Interfaces:

DocumentSearchService

public class DocumentSearchServiceImpl
extends Object
implements DocumentSearchService

Constructor Summary

DocumentSearchServiceImpl()

Method Summary

protected DocSearchCriteriaDTO	applyCriteriaCustomizations(DocumentType documentType, DocSearchCriteriaDTO criteria) Applies any document type-specific customizations to the lookup criteria.
void	clearNamedSearches(String principalId)
DataDictionaryService	getDataDictionaryService()
DictionaryValidationService	getDictionaryValidationService()
protected DocumentLookupCustomizationMediator	getDocumentLookupCustomizationMediator()
ConfigurationService	getKualiConfigurationService()
DocumentSearchResultComponents	getList(String principalId, DocSearchCriteriaDTO criteria) This method performs a standard document search
DocumentSearchResultComponents	getListRestrictedByCriteria(String principalId, DocSearchCriteriaDTO criteria) This method performs a standard document search but uses the value returned by DocSearchCriteriaDTO.getThreshold() as the maximum search results returned
List<KeyValue>	getMostRecentSearches(String principalId)
List<KeyValue>	getNamedSearches(String principalId)
SavedSearchResult	getSavedSearchResults(String principalId, String savedSearchName)
SqlBuilder	getSqlBuilder()
DocumentSearchGenerator	getStandardDocumentSearchGenerator()
DocumentSearchResultProcessor	getStandardDocumentSearchResultProcessor()
void	performPreSearchConditions(DocumentSearchGenerator docSearchGenerator, String principalId, DocSearchCriteriaDTO criteria)
void	setDocumentLookupCustomizationMediator(DocumentLookupCustomizationMediator documentLookupCustomizationMediator)
void	setDocumentSearchDAO(DocumentSearchDAO docSearchDao)
void	setSqlBuilder(SqlBuilder sqlBuilder)
void	setUserOptionsService(UserOptionsService userOptionsService)
void	validateDocumentSearchCriteria(DocumentSearchGenerator docSearchGenerator, DocSearchCriteriaDTO criteria)
protected List<WorkflowServiceError>	validateWorkflowDocumentSearchCriteria(DocSearchCriteriaDTO criteria)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentSearchServiceImpl

public DocumentSearchServiceImpl()

Method Detail

setDocumentSearchDAO

public void setDocumentSearchDAO(DocumentSearchDAO docSearchDao)

setUserOptionsService

public void setUserOptionsService(UserOptionsService userOptionsService)

setDocumentLookupCustomizationMediator

public void setDocumentLookupCustomizationMediator(DocumentLookupCustomizationMediator documentLookupCustomizationMediator)

getDocumentLookupCustomizationMediator

protected DocumentLookupCustomizationMediator getDocumentLookupCustomizationMediator()

clearNamedSearches

public void clearNamedSearches(String principalId)

Specified by:

clearNamedSearches in interface DocumentSearchService

getSavedSearchResults

public SavedSearchResult getSavedSearchResults(String principalId,
                                               String savedSearchName)

Specified by:

getSavedSearchResults in interface DocumentSearchService

getList

public DocumentSearchResultComponents getList(String principalId,
                                              DocSearchCriteriaDTO criteria)

Description copied from interface: DocumentSearchService

This method performs a standard document search

Specified by:

getList in interface DocumentSearchService

Parameters:

principalId - - user executing the search

criteria - - criteria to use to search documents

Returns:

a DocumentSearchResultComponents object holding the search result columns and search result rows represented by a list of DocumentSearchResult objects

getListRestrictedByCriteria

public DocumentSearchResultComponents getListRestrictedByCriteria(String principalId,
                                                                  DocSearchCriteriaDTO criteria)

Description copied from interface: DocumentSearchService

This method performs a standard document search but uses the value returned by DocSearchCriteriaDTO.getThreshold() as the maximum search results returned

Specified by:

getListRestrictedByCriteria in interface DocumentSearchService

Parameters:

principalId - - user executing the search

criteria - - criteria to use to search documents

Returns:

a DocumentSearchResultComponents object holding the search result columns and search result rows represented by a list of DocumentSearchResult objects

applyCriteriaCustomizations

protected DocSearchCriteriaDTO applyCriteriaCustomizations(DocumentType documentType,
                                                           DocSearchCriteriaDTO criteria)

Applies any document type-specific customizations to the lookup criteria. If no customizations are configured for the document type, this method will simply return the criteria that is passed to it. If the given DocumentType is null, then this method will also simply return the criteria that is passed to it.

getStandardDocumentSearchGenerator

public DocumentSearchGenerator getStandardDocumentSearchGenerator()

Specified by:

getStandardDocumentSearchGenerator in interface DocumentSearchService

getStandardDocumentSearchResultProcessor

public DocumentSearchResultProcessor getStandardDocumentSearchResultProcessor()

Specified by:

getStandardDocumentSearchResultProcessor in interface DocumentSearchService

performPreSearchConditions

public void performPreSearchConditions(DocumentSearchGenerator docSearchGenerator,
                                       String principalId,
                                       DocSearchCriteriaDTO criteria)

validateDocumentSearchCriteria

public void validateDocumentSearchCriteria(DocumentSearchGenerator docSearchGenerator,
                                           DocSearchCriteriaDTO criteria)

Specified by:

validateDocumentSearchCriteria in interface DocumentSearchService

validateWorkflowDocumentSearchCriteria

protected List<WorkflowServiceError> validateWorkflowDocumentSearchCriteria(DocSearchCriteriaDTO criteria)

getNamedSearches

public List<KeyValue> getNamedSearches(String principalId)

Specified by:

getNamedSearches in interface DocumentSearchService

getMostRecentSearches

public List<KeyValue> getMostRecentSearches(String principalId)

Specified by:

getMostRecentSearches in interface DocumentSearchService

getDictionaryValidationService

public DictionaryValidationService getDictionaryValidationService()

getDataDictionaryService

public DataDictionaryService getDataDictionaryService()

getKualiConfigurationService

public ConfigurationService getKualiConfigurationService()

getSqlBuilder

public SqlBuilder getSqlBuilder()

Returns:

the sqlBuilder

setSqlBuilder

public void setSqlBuilder(SqlBuilder sqlBuilder)

Parameters:

sqlBuilder - the sqlBuilder to set