Package com.adobe.cq.commerce.core.search.models

Interface SearchResultsSet

    • Method Detail

      • getSearchOptions

        @Nonnull
SearchOptions getSearchOptions()
        Get the search options used to provide this search result set.
        Returns:
        the SearchOptions used in the search

      • getTotalResults

        @Nonnull
Integer getTotalResults()
        Get the total number of results.
        Returns:
        the total number of results

      • getAppliedQueryParameters

        @Nonnull
Map<String,​String> getAppliedQueryParameters()
        Get a map of the applied search query string parameters.
        Returns:
        the query string parameters (key value pairs)

      • getProductListItems

        @Nonnull
List<ProductListItem> getProductListItems()
        Get the result product list items. These are the actual result of the search.
        Returns:
        the resulting products

      • getSearchAggregations

        @Nonnull
List<SearchAggregation> getSearchAggregations()
        Get the available search aggregations for the given result set.
        Returns:
        the aggregations or filters available for the search result set.

      • getAppliedAggregations

        @Nonnull
List<SearchAggregation> getAppliedAggregations()
        Get the list of aggregations or filters that were applied in this search.
        Returns:
        the applied filter aggregations

      • getAvailableAggregations

        @Nonnull
List<SearchAggregation> getAvailableAggregations()
        Get the available search aggregations for the given result set
        Returns:
        the available aggregations

      • getPager

        @Nonnull
Pager getPager()
        Returns:
        The pager model, responsible for handling the pagination of search results.

      • getSorter

        @Nonnull
Sorter getSorter()
        Returns:
        The sorter model, responsible for handling the sorting of search results.

      • hasAggregations

        boolean hasAggregations()
        Returns:
        true if the result set provides search aggregations for faceted search support, false otherwise

      • hasPagination

        boolean hasPagination()
        Returns:
        true if the result set provides pagination, false otherwise

      • hasSorting

        boolean hasSorting()
        Returns:
        true if the result set provides support for sorting of the results, false otherwise