atg.search.formhandlers
Interface SearchRequestProcessor

All Known Implementing Classes:

CommerceFacetSearchTools, CustomCatalogFacetSearchTools, FacetSearchTools, SearchConfigurationRequestProcessor

public interface SearchRequestProcessor

The atg.search.formhandlers.BaseSearchFormHandler has a property that contains a list of SearchRequestProcessor components. The form handler iterates through these SearchRequestProcessor components before performing a search, calling each component's processSearchRequest method in turn.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

SearchRequest

processSearchRequest(SearchRequest pSearchRequest, DynamoHttpServletRequest pDynamoRequest, java.lang.Object pCallback) perform operations on a search request before a search is performed.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

processSearchRequest

SearchRequest processSearchRequest(SearchRequest pSearchRequest,
                                   DynamoHttpServletRequest pDynamoRequest,
                                   java.lang.Object pCallback)
                                   throws atg.search.client.SearchClientException

perform operations on a search request before a search is performed.

Parameters:

pSearchRequest - the search request object

pDynamoRequest - the dynamo request

pCallback - the form handler component that called this method

Throws:

atg.search.client.SearchClientException