com.adobe.cq.social.forum.api

Interface ForumSearch

Deprecated.

@since AEM 6.0. Use SearchResultComponent instead.

@Deprecated
public interface ForumSearch

Provides forum search capability. The search searches all forums within /content, unless the user restricted the search to one or more forum paths.

Instantiating a search will make the search instance available as a request attribute of name ATTRIBUTE_NAME_SEARCH. Currently the search can only search one forum at a time, as specified by the respective content property.

Since:

CQ 5.6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ForumSearch.Page Deprecated. Page extends from ResultPage which represents one page of the search result.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME_RESULTPAGES Deprecated. Property for forum search result pages.
static String	ATTRIBUTE_NAME_SEARCH Deprecated. Property for forum search.
static String	PN_SEARCHPATHS Deprecated. Property for search paths.
static String	PN_TEXTNORESULTS Deprecated. Property for text no results.
static String	PN_TEXTONEMATCH Deprecated. Property for text one match.
static String	PN_TEXTRESULTS Deprecated. Property for text results.
static String	PN_TEXTSEARCHBUTTON Deprecated. Property for text search button.
static String	REQUEST_PARAM_QUERY Deprecated. Property for request parameter query.
static String	REQUEST_PARAM_QUERY_SCOPE Deprecated. Property for request parameter query scope.
static String	REQUEST_PARAM_START Deprecated. Property for request parameter start.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPredicate(Predicate predicate) Deprecated. Allows the addition of custom query builder Predicates to refine the search.
String	getQuery() Deprecated. Returns the search query as entered by the user and retrieved from the request.
SearchResult	getResult() Deprecated. Executes the query and returns the results.
List<ForumSearch.Page>	getResultPages() Deprecated. Executes the search (see getResult() and returns the results split into the result pages.
String[]	getScopeProperties() Deprecated. Returns the scope properties as selected by the user in the search form, i.e.
String	getTextNoResults() Deprecated. Returns the text configured for this search for when no search results were found.
String	getTextOneMatch() Deprecated. Returns the text configured for this search for when exactly one match was found.
String	getTextResults() Deprecated. Returns the text configured for this search for information about the results found.
String	getTextSearchButton() Deprecated. Returns the text configured for this search for the label of the search button.

Field Detail

ATTRIBUTE_NAME_RESULTPAGES

static final String ATTRIBUTE_NAME_RESULTPAGES

Deprecated.

Property for forum search result pages.

ATTRIBUTE_NAME_SEARCH

static final String ATTRIBUTE_NAME_SEARCH

Deprecated.

Property for forum search.

PN_SEARCHPATHS

static final String PN_SEARCHPATHS

Deprecated.

Property for search paths.

See Also:

Constant Field Values

PN_TEXTNORESULTS

static final String PN_TEXTNORESULTS

Deprecated.

Property for text no results.

See Also:

Constant Field Values

PN_TEXTONEMATCH

static final String PN_TEXTONEMATCH

Deprecated.

Property for text one match.

See Also:

Constant Field Values

PN_TEXTRESULTS

static final String PN_TEXTRESULTS

Deprecated.

Property for text results.

See Also:

Constant Field Values

PN_TEXTSEARCHBUTTON

static final String PN_TEXTSEARCHBUTTON

Deprecated.

Property for text search button.

See Also:

Constant Field Values

REQUEST_PARAM_QUERY

static final String REQUEST_PARAM_QUERY

Deprecated.

Property for request parameter query.

See Also:

Constant Field Values

REQUEST_PARAM_QUERY_SCOPE

static final String REQUEST_PARAM_QUERY_SCOPE

Deprecated.

Property for request parameter query scope.

See Also:

Constant Field Values

REQUEST_PARAM_START

static final String REQUEST_PARAM_START

Deprecated.

Property for request parameter start.

See Also:

Constant Field Values

Method Detail

getQuery

String getQuery()

Deprecated.

Returns the search query as entered by the user and retrieved from the request.

Returns:

A String representing the search query or null if none was specified.

getScopeProperties

String[] getScopeProperties()

Deprecated.

Returns the scope properties as selected by the user in the search form, i.e. which properties are to be searched.

Returns:

A String[] representing the selected scope properties or an empty array if none was defined.

getResult

SearchResult getResult()
                       throws ForumException

Deprecated.

Executes the query and returns the results. Consecutive calls to this method will always return the same result (cached).

Returns:

A SearchResult.

Throws:

ForumException - If an error occurred while searching.

getResultPages

List<ForumSearch.Page> getResultPages()
                                      throws ForumException

Deprecated.

Executes the search (see getResult() and returns the results split into the result pages. The method also sets a request attribute of name ATTRIBUTE_NAME_RESULTPAGES containing the list of pages. Consecutive calls to this method will always return the same page list (cached).

Returns:

An unmodifiable list of ForumSearch.Pages.

Throws:

ForumException - If an error occurred while searching.

addPredicate

void addPredicate(Predicate predicate)

Deprecated.

Allows the addition of custom query builder Predicates to refine the search.

Parameters:

predicate - The predicate to be added.

getTextNoResults

String getTextNoResults()

Deprecated.

Returns the text configured for this search for when no search results were found.

Returns:

A String representing the text.

getTextOneMatch

String getTextOneMatch()

Deprecated.

Returns the text configured for this search for when exactly one match was found.

Returns:

A String representing the text.

getTextResults

String getTextResults()

Deprecated.

Returns the text configured for this search for information about the results found.

Returns:

A String representing the text.

getTextSearchButton

String getTextSearchButton()

Deprecated.

Returns the text configured for this search for the label of the search button.

Returns:

A String representing the text.