com.valtech.aem.saas.api.fulltextsearch

Interface FulltextSearchService

public interface FulltextSearchService

Represents a service that performs fulltext search queries and retrieves the according results.

Method Summary

Modifier and Type	Method and Description
default Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull String language, int start, int rows) Gets search results according the context aware configuration.
default Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull String language, int start, int rows, Set<Filter> filters) Gets search results according the context aware configuration.
default Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, @NonNull String language, int start, int rows, Set<Filter> filters, Set<String> facets) Gets search results according the context aware configuration.
default Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, String searchText, @NonNull String language, int start, int rows) Gets search results according the context aware configuration.
default Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, String searchText, @NonNull String language, int start, int rows, Set<Filter> filters) Gets search results according the context aware configuration.
Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, String searchText, @NonNull String language, int start, int rows, Set<Filter> filters, Set<String> facets, boolean disableContextFilters, String template)
Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, String searchText, @NonNull String language, int start, int rows, Set<Filter> filters, Set<String> facets, boolean disableContextFilters, String template, List<org.apache.commons.lang3.tuple.Pair<String,Sort>> sortParameters)
Optional<FulltextSearchResultsDTO>	getResults(@NonNull SearchCAConfigurationModel searchConfiguration, String searchText, @NonNull String language, int start, int rows, Set<Filter> filters, Set<String> facets, String template)

Method Detail

getResults

default Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                                      @NonNull SearchCAConfigurationModel searchConfiguration,
                                                      @NonNull
                                                      @NonNull String language,
                                                      int start,
                                                      int rows)

Gets search results according the context aware configuration.

Parameters:

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

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

Returns:

search results object

getResults

default Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                                      @NonNull SearchCAConfigurationModel searchConfiguration,
                                                      String searchText,
                                                      @NonNull
                                                      @NonNull String language,
                                                      int start,
                                                      int rows)

Gets search results according the context aware configuration.

Parameters:

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

searchText - full text query value.

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

Returns:

search results object

getResults

default Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                                      @NonNull SearchCAConfigurationModel searchConfiguration,
                                                      String searchText,
                                                      @NonNull
                                                      @NonNull String language,
                                                      int start,
                                                      int rows,
                                                      Set<Filter> filters)

Gets search results according the context aware configuration.

Parameters:

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

searchText - full text query value.

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

Returns:

search results object

getResults

default Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                                      @NonNull SearchCAConfigurationModel searchConfiguration,
                                                      @NonNull
                                                      @NonNull String language,
                                                      int start,
                                                      int rows,
                                                      Set<Filter> filters)

Gets search results according the context aware configuration.

Parameters:

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

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

Returns:

search results object

getResults

default Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                                      @NonNull SearchCAConfigurationModel searchConfiguration,
                                                      @NonNull
                                                      @NonNull String language,
                                                      int start,
                                                      int rows,
                                                      Set<Filter> filters,
                                                      Set<String> facets)

Gets search results according the context aware configuration.

Parameters:

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

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

facets - list of field names.

Returns:

search results object

getResults

Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                              @NonNull SearchCAConfigurationModel searchConfiguration,
                                              String searchText,
                                              @NonNull
                                              @NonNull String language,
                                              int start,
                                              int rows,
                                              Set<Filter> filters,
                                              Set<String> facets,
                                              String template)

Parameters:

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

searchText - full text query value.

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

facets - list of field names.

Returns:

search results object

getResults

Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                              @NonNull SearchCAConfigurationModel searchConfiguration,
                                              String searchText,
                                              @NonNull
                                              @NonNull String language,
                                              int start,
                                              int rows,
                                              Set<Filter> filters,
                                              Set<String> facets,
                                              boolean disableContextFilters,
                                              String template)

Parameters:

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

searchText - full text query value.

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

facets - list of field names.

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

template - a template to filter by.

Returns:

search results object

getResults

Optional<FulltextSearchResultsDTO> getResults(@NonNull
                                              @NonNull SearchCAConfigurationModel searchConfiguration,
                                              String searchText,
                                              @NonNull
                                              @NonNull String language,
                                              int start,
                                              int rows,
                                              Set<Filter> filters,
                                              Set<String> facets,
                                              boolean disableContextFilters,
                                              String template,
                                              List<org.apache.commons.lang3.tuple.Pair<String,Sort>> sortParameters)

Parameters:

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

searchText - full text query value.

language - full text search language scope.

start - the start page for search results.

rows - the number of results per page

filters - additional filters of type SimpleFilter or CompositeFilter

facets - list of field names.

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

template - a template to filter by.

sortParameters - a list of field - sort direction parameters used for sorting of results.

Returns:

search results object