com.day.cq.searchpromote

Class Search

java.lang.Object

com.day.cq.searchpromote.Search

Deprecated.

@ProviderType
 @Deprecated
public final class Search
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PN_ACCOUNT_NUMBER Deprecated. Property name account number
static java.lang.String	PN_MEMBER_ID Deprecated. Property name member ID
static java.lang.String	PN_SEARCHFORMXML Deprecated. Property name search form XML
static java.lang.String	QUERY_PARAM_NAME Deprecated. Query parameter
static java.lang.String	VALID_QUERY_PATTERN Deprecated. Valid query pattern

Constructor Summary

Constructors

Constructor and Description
Search(SlingHttpServletRequest request, Configuration configuration) Deprecated. Use Search(SlingHttpServletRequest, Configuration, HttpClientBuilderFactory) instead.
Search(SlingHttpServletRequest request, Configuration configuration, HttpClientBuilderFactory httpClientBuilderFactory) Deprecated. Creates a new instance of a Search object.
Search(SlingHttpServletRequest request, Configuration configuration, HttpClientBuilderFactory httpClientBuilderFactory, int connectionTimeout, int socketTimeout) Deprecated. Creates a new instance of a Search object.

Method Summary

Modifier and Type	Method and Description
Banner	getBanner(java.lang.String bannerArea) Deprecated. Returns the Banner for the specified bannerArea or null if it could not be found.
java.util.List<Banner>	getBanners() Deprecated. Returns a List of Banners.
java.util.List<BreadCrumbItem>	getBreadcrumbs() Deprecated. Returns a List of BreadCrumbItem's.
java.lang.Long	getExecutionTime() Deprecated. Returns query execution time.
Facet	getFacet(java.lang.String name) Deprecated. Returns the Facet with the specified name or null if it could not be found.
java.util.List<Facet>	getFacets() Deprecated. Returns a List of Facet's.
Menu	getMenu(java.lang.String menuName) Deprecated. Returns the Menu for the specified menuName or null if it could not be found.
java.util.List<Menu>	getMenus() Deprecated. Returns a List of Menus.
Pagination	getPagination() Deprecated. Returns the Pagination.
Query	getQuery() Deprecated. Returns the Query.
static java.lang.String	getQueryParameter(java.lang.String queryString, java.lang.String parameter) Deprecated. Returns a query parameter from the provided query string.
java.lang.String	getQueryString() Deprecated. Returns current query string.
java.lang.String	getRedirect() Deprecated. Returns a String containing the url to redirect to.
java.util.List<Result>	getResults() Deprecated. Returns a List of Result's.
SearchForm	getSearchForm() Deprecated. Returns the SearchForm.
Suggestions	getSuggestion() Deprecated. Returns a Suggestions object.
java.util.List<Suggestion>	getSuggestions() Deprecated. Returns a List of Suggestion's.
void	setQueryString(java.lang.String query) Deprecated. Sets query string.
boolean	shouldRedirect() Deprecated. Returns a Boolean wether the request should be redirected

Methods inherited from class java.lang.Object

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

Field Detail

VALID_QUERY_PATTERN

public static final java.lang.String VALID_QUERY_PATTERN

Deprecated.

Valid query pattern

See Also:

Constant Field Values

QUERY_PARAM_NAME

public static final java.lang.String QUERY_PARAM_NAME

Deprecated.

Query parameter

See Also:

Constant Field Values

PN_MEMBER_ID

public static final java.lang.String PN_MEMBER_ID

Deprecated.

Property name member ID

See Also:

Constant Field Values

PN_ACCOUNT_NUMBER

public static final java.lang.String PN_ACCOUNT_NUMBER

Deprecated.

Property name account number

See Also:

Constant Field Values

PN_SEARCHFORMXML

public static final java.lang.String PN_SEARCHFORMXML

Deprecated.

Property name search form XML

See Also:

Constant Field Values

Constructor Detail

Search

@Deprecated
public Search(SlingHttpServletRequest request,
                          Configuration configuration)
                   throws SearchPromoteException

Deprecated. Use Search(SlingHttpServletRequest, Configuration, HttpClientBuilderFactory) instead.

Creates a new instance of a Search object.

Parameters:

request - SlingHttpServletRequest

configuration - Configuration

Throws:

SearchPromoteException - SearchPromoteException if an error occurs

Search

public Search(SlingHttpServletRequest request,
              Configuration configuration,
              HttpClientBuilderFactory httpClientBuilderFactory,
              int connectionTimeout,
              int socketTimeout)
       throws SearchPromoteException

Deprecated.

Creates a new instance of a Search object.

Parameters:

request - The SlingHttpServletRequest

configuration - The Configuration

httpClientBuilderFactory - The HttpClientBuilderFactory

connectionTimeout - Timeout in milliseconds until a connection is established. A timeout value of 0 is interpreted as an infinite timeout.

socketTimeout - Timeout in milliseconds, which is the timeout for waiting for data or a maximum period of inactivity between two consecutive data packets. A timeout value of 0 is interpreted as an infinite timeout.

Throws:

SearchPromoteException - if an error occurs

Search

public Search(SlingHttpServletRequest request,
              Configuration configuration,
              HttpClientBuilderFactory httpClientBuilderFactory)
       throws SearchPromoteException

Deprecated.

Creates a new instance of a Search object.

Parameters:

request - SlingHttpServletRequest

configuration - Configuration

httpClientBuilderFactory - HttpClientBuilderFactory

Throws:

SearchPromoteException - SearchPromoteException if an error occurs

Method Detail

getQueryParameter

public static java.lang.String getQueryParameter(java.lang.String queryString,
                                                 java.lang.String parameter)

Deprecated.

Returns a query parameter from the provided query string. Additional to the delimiter & the Search&Promote parameter delimiters ; and / are supported.

Parameters:

queryString - queryString

parameter - parameter

Returns:

query parameter

getQueryString

public java.lang.String getQueryString()

Deprecated.

Returns current query string.

Returns:

query string

setQueryString

public void setQueryString(java.lang.String query)

Deprecated.

Sets query string.

Parameters:

query - querystring

getSearchForm

public SearchForm getSearchForm()

Deprecated.

Returns the SearchForm.

Returns:

SearchForm

getQuery

public Query getQuery()

Deprecated.

Returns the Query.

Returns:

Query

getBreadcrumbs

public java.util.List<BreadCrumbItem> getBreadcrumbs()

Deprecated.

Returns a List of BreadCrumbItem's.

Returns:

List of BreadCrumbItems

getPagination

public Pagination getPagination()

Deprecated.

Returns the Pagination.

Returns:

Pagination

getResults

public java.util.List<Result> getResults()

Deprecated.

Returns a List of Result's.

Returns:

List of Results.

getRedirect

public java.lang.String getRedirect()

Deprecated.

Returns a String containing the url to redirect to.

Returns:

String containing the url to redirect to

shouldRedirect

public boolean shouldRedirect()

Deprecated.

Returns a Boolean wether the request should be redirected

Returns:

Boolean wether the request should be redirected

getSuggestion

public Suggestions getSuggestion()

Deprecated.

Returns a Suggestions object.

Returns:

Suggestions object

getSuggestions

public java.util.List<Suggestion> getSuggestions()

Deprecated.

Returns a List of Suggestion's.

Returns:

List of Suggestions

getFacets

public java.util.List<Facet> getFacets()

Deprecated.

Returns a List of Facet's.

Returns:

List of Facets.

getFacet

public Facet getFacet(java.lang.String name)

Deprecated.

Returns the Facet with the specified name or null if it could not be found.

Parameters:

name - facet name

Returns:

Facet with specified name

getBanners

public java.util.List<Banner> getBanners()

Deprecated.

Returns a List of Banners.

Returns:

List of Banners

getBanner

public Banner getBanner(java.lang.String bannerArea)

Deprecated.

Returns the Banner for the specified bannerArea or null if it could not be found.

Parameters:

bannerArea - bannerArea

Returns:

Banner

getMenus

public java.util.List<Menu> getMenus()

Deprecated.

Returns a List of Menus.

Returns:

list of menus

getMenu

public Menu getMenu(java.lang.String menuName)

Deprecated.

Returns the Menu for the specified menuName or null if it could not be found.

Parameters:

menuName - menuName

Returns:

Menu

getExecutionTime

public java.lang.Long getExecutionTime()

Deprecated.

Returns query execution time. The execution time is built on the sum of request time and parsing time.

Returns:

Execution time in milliseconds