io.sphere.sdk.search.FacetedSearchDsl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sphere-common Show documentation
sphere-common
There is a newer version: 1.0.0-M26
package io.sphere.sdk.search;

import java.util.List;

public interface FacetedSearchDsl extends FacetedSearchSupport {

    /**
     * Returns a new object with the new faceted search expression list as faceted search (combination of the query parameter {@code facet}
     * with the facet expression and the query parameters {@code filter.facet} and {@code filter} with the filter expressions).
     * This enables the behaviour of the faceted search as explained in the documentation.
     * @param facetedSearchExpressions the new faceted search expression list
     * @return a new object with faceted search
     */
    C withFacetedSearch(final List> facetedSearchExpressions);

    /**
     * Returns a new object with the new faceted search expression as facets (combination of the query parameter {@code facet}
     * with the facet expression and the query parameters {@code filter.facet} and {@code filter} with the filter expressions).
     * This enables the behaviour of the faceted search as explained in the documentation.
     * @param facetedSearchExpression the new faceted search expression
     * @return a new object with faceted search
     */
    C withFacetedSearch(final FacetAndFilterExpression facetedSearchExpression);

    /**
     * Returns a ResourceSearch with the new faceted search expression list appended to the existing faceted search (combination of the query parameter {@code facet}
     * with the facet expression and the query parameters {@code filter.facet} and {@code filter} with the filter expressions).
     * This enables the behaviour of the faceted search as explained in the documentation.
     * @param facetedSearchExpressions the new faceted search expression list
     * @return a ResourceSearch with the existing faceted search plus the new faceted search list.
     */
    C plusFacetedSearch(final List> facetedSearchExpressions);

    /**
     * Returns a new object with the new faceted search expression appended to the existing faceted search (combination of the query parameter {@code facet}
     * with the facet expression and the query parameters {@code filter.facet} and {@code filter} with the filter expressions).
     * This enables the behaviour of the faceted search as explained in the documentation.
     * @param facetedSearchExpression the new faceted search expression
     * @return a new object with the existing faceted search plus the new facet.
     */
    C plusFacetedSearch(final FacetAndFilterExpression facetedSearchExpression);

}