com.valtech.aem.saas.api.autocomplete

Interface AutocompleteService

public interface AutocompleteService

Service that consumes the SaaS typeahead (autocomplete) api.

Method Summary

Modifier and Type	Method and Description
default List<String>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull String text, @NonNull String language, Set<Filter> filters) Retrieves typeahead (autocomplete) results
List<String>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull String text, @NonNull String language, Set<Filter> filters, boolean disableContextFilters) Retrieves typeahead (autocomplete) results

Method Detail

getResults

default List<String> getResults(@NonNull
                                @NonNull SearchCAConfigurationModel searchConfiguration,
                                @NonNull
                                @NonNull String text,
                                @NonNull
                                @NonNull String language,
                                Set<Filter> filters)

Retrieves typeahead (autocomplete) results

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

text - search term.

language - search language scope.

filters - search filters

Returns:

List of string represented autocomplete options. Empty list if no options are found.

getResults

List<String> getResults(@NonNull
                        @NonNull SearchCAConfigurationModel searchConfiguration,
                        @NonNull
                        @NonNull String text,
                        @NonNull
                        @NonNull String language,
                        Set<Filter> filters,
                        boolean disableContextFilters)

Retrieves typeahead (autocomplete) results

Parameters:

searchConfiguration - sling model accessing context aware search configurations (i.e client and index).

text - search term.

language - search language scope.

filters - search filters

disableContextFilters - flag to disable the filters configured in context aware configuration.

Returns:

List of string represented autocomplete options. Empty list if no options are found.