com.valtech.aem.saas.api.fulltextsearch

Interface SearchTabModel

public interface SearchTabModel

Represents a model of the aem search results component.

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERY_PARAM_FACET_FILTER
static String	QUERY_PARAM_PAGE
static String	QUERY_PARAM_SEARCH_TERM

Method Summary

Modifier and Type	Method and Description
FacetFiltersDTO	getFacetFilters() Retrieves a list of facet filter items.
List<ResultDTO>	getResults() Retrieves the results for the specified search query (query params in request)
int	getResultsTotal() Get the total number of results found.
SuggestionDTO	getSuggestion() Get search suggestion if there is one.
default String	getTabId() Retrieves the tabId configurable for the search tab component.
String	getTitle() Retrieves the title configurable for the search tab component.
String	getUrl() Retrieves the json export url.
boolean	isShowLoadMoreButton() A boolean flag used for displaying the load more button.

Field Detail

QUERY_PARAM_SEARCH_TERM

static final String QUERY_PARAM_SEARCH_TERM

See Also:

Constant Field Values

QUERY_PARAM_PAGE

static final String QUERY_PARAM_PAGE

See Also:

Constant Field Values

QUERY_PARAM_FACET_FILTER

static final String QUERY_PARAM_FACET_FILTER

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle()

Retrieves the title configurable for the search tab component.

Returns:

configured title.

getFacetFilters

FacetFiltersDTO getFacetFilters()

Retrieves a list of facet filter items.

Returns:

list of facet filter names.

getResults

List<ResultDTO> getResults()

Retrieves the results for the specified search query (query params in request)

Returns:

list of results

getSuggestion

SuggestionDTO getSuggestion()

Get search suggestion if there is one.

Returns:

an object containing suggestion details.

getResultsTotal

int getResultsTotal()

Get the total number of results found.

Returns:

number of results.

isShowLoadMoreButton

boolean isShowLoadMoreButton()

A boolean flag used for displaying the load more button.

Returns:

true if there are more results to be loaded.

getUrl

String getUrl()

Retrieves the json export url.

Returns:

url string

getTabId

default String getTabId()

Retrieves the tabId configurable for the search tab component.

Returns:

configured tabId.