com.valtech.aem.saas.api.fulltextsearch

Interface SearchModel

All Superinterfaces:

SearchInputModel

public interface SearchModel
extends SearchInputModel

Represents a model of the aem search component.

Method Summary

Modifier and Type	Method and Description
String	getAutoSuggestText() Gets the suggestion text, with placeholder, when a misspelled search term is entered.
Set<Filter>	getFilters() Retrieves search filter queries.
String	getLanguage() Retrieves the language override configurable for the search component.
String	getLoadMoreButtonText() Gets the label for the load more results button
String	getNoResultsText() Gets the text that is displayed when no results are found.
int	getResultsPerPage() Retrieves an author configured value for the max limit of results per request/page
String	getSearchButtonText() Gets the label for the search button.
List<SearchTabModel>	getSearchTabs() Gets list of search tabs;
String	getTitle() Retrieves the title configurable for the search component.
default String	getTrackingUrl() Gets the tracking url of the search component.
default boolean	isDisableContextFilters() Flag to determine whether the filters from context aware configuration should be used for searching.

Methods inherited from interface com.valtech.aem.saas.api.fulltextsearch.SearchInputModel

getAutocompleteTriggerThreshold, getAutocompleteUrl, getConfigJson, getId, getSearchFieldPlaceholderText

Method Detail

getTitle

String getTitle()

Retrieves the title configurable for the search component.

Returns:

configured title.

getLanguage

String getLanguage()

Retrieves the language override configurable for the search component.

Returns:

configured language.

getFilters

Set<Filter> getFilters()

Retrieves search filter queries.

Returns:

set of filter details.

getResultsPerPage

int getResultsPerPage()

Retrieves an author configured value for the max limit of results per request/page

Returns:

max number of results per request.

getSearchButtonText

String getSearchButtonText()

Gets the label for the search button.

Returns:

search button text.

getLoadMoreButtonText

String getLoadMoreButtonText()

Gets the label for the load more results button

Returns:

load more button text.

getSearchTabs

List<SearchTabModel> getSearchTabs()

Gets list of search tabs;

Returns:

list of search tabs.

getAutoSuggestText

String getAutoSuggestText()

Gets the suggestion text, with placeholder, when a misspelled search term is entered.

Returns:

suggestion text with placeholder.

getNoResultsText

String getNoResultsText()

Gets the text that is displayed when no results are found.

Returns:

no results text.

getTrackingUrl

default String getTrackingUrl()

Gets the tracking url of the search component. Tracking is done on client interaction with search results.

Returns:

url string.

isDisableContextFilters

default boolean isDisableContextFilters()

Flag to determine whether the filters from context aware configuration should be used for searching.

Returns:

disable context filters flag.