com.valtech.aem.saas.api.caconfig

Interface SearchCAConfigurationModel

public interface SearchCAConfigurationModel

A model that provides context-aware search configurations.

Method Summary

Modifier and Type	Method and Description
int	getAutocompleteResultsMaxTotal() Gets the autocomplete max total allowed.
int	getAutocompleteThreshold() Gets the autocomplete trigger threshold.
Set<Filter>	getFilters() Retrieves set of query ready items.
String	getHighlightTagName() Retrieves the name of the tag which will be used to highlight text matches in resulting search content.
String	getIndex() Retrieves configured index value.
int	getProjectId() Retrieves configured project id.
boolean	isAutocompleteEnabled() Checks whether autocomplete feature is enabled.
boolean	isAutoSuggestEnabled() Checks whether auto suggest feature is enabled.
boolean	isBestBetsEnabled() Checks whether best bets feature is enabled.
default boolean	isSearchResultItemTrackingEnabled() Checks whether search result items click tracking is enabled.

Method Detail

getIndex

String getIndex()

Retrieves configured index value. Index is considered required.

Returns:

saas index

Throws:

IllegalStateException - thrown when index value is blank.

getProjectId

int getProjectId()

Retrieves configured project id. Project id is considered required.

Returns:

saas project id

Throws:

IllegalStateException - thrown when project id is blank.

getFilters

Set<Filter> getFilters()

Retrieves set of query ready items.

Returns:

set of filter entries.

getHighlightTagName

String getHighlightTagName()

Retrieves the name of the tag which will be used to highlight text matches in resulting search content.

Returns:

html tag name.

isBestBetsEnabled

boolean isBestBetsEnabled()

Checks whether best bets feature is enabled.

Returns:

true if enabled.

isAutoSuggestEnabled

boolean isAutoSuggestEnabled()

Checks whether auto suggest feature is enabled.

Returns:

true if enabled.

isAutocompleteEnabled

boolean isAutocompleteEnabled()

Checks whether autocomplete feature is enabled.

Returns:

true if enabled.

getAutocompleteThreshold

int getAutocompleteThreshold()

Gets the autocomplete trigger threshold. That is the minimum number of characters entered before displaying a selection of autocomplete options/suggestions.

Returns:

positive integer.

getAutocompleteResultsMaxTotal

int getAutocompleteResultsMaxTotal()

Gets the autocomplete max total allowed.

Returns:

positive integer.

isSearchResultItemTrackingEnabled

default boolean isSearchResultItemTrackingEnabled()

Checks whether search result items click tracking is enabled.

Returns:

true if enabled.