atg.search.formhandlers

Interface SearchRedirectProcessor

public interface SearchRedirectProcessor

The atg.search.formhandlers.BaseSearchFormHandler has a property that contains a list of SearchRedirectProcessor components. The form handler iterates through these SearchRedirectProcessor components after performing a search and after processing the response, calling each component's processSearchRedirect method in turn.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRedirect(SearchResponse pSearchResponse) if a redirect is required, get the url to redirect to
boolean	handleAutoRedirect(SearchResponse pSearchResponse, DynamoHttpServletRequest pDynamoRequest, java.lang.Object pCallback) determine whether a redirect is required after a search request

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

handleAutoRedirect

boolean handleAutoRedirect(SearchResponse pSearchResponse,
                           DynamoHttpServletRequest pDynamoRequest,
                           java.lang.Object pCallback)
                    throws atg.search.client.SearchClientException

determine whether a redirect is required after a search request

Parameters:

pSearchResponse - the search response object

pDynamoRequest - the dynamo request

pCallback - the form handler component that called this method

Returns:

true if a redirect should happen, false if not

Throws:

atg.search.client.SearchClientException

getRedirect

java.lang.String getRedirect(SearchResponse pSearchResponse)

if a redirect is required, get the url to redirect to

Parameters:

pSearchResponse - the search response

Returns:

the redirect url