io.sphere.sdk.search.FacetDsl 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 FacetDsl extends FacetSupport {

    /**
     * Returns a new object with the new facet expression list as facets (query parameter {@code facet}).
     * @param facetExpressions the new facet expression list
     * @return a new object with facets
     */
    C withFacets(final List> facetExpressions);

    /**
     * Returns a new object with the new facet expression as facets (query parameter {@code facet}).
     * @param facetExpression the new facet expression
     * @return a new object with facets
     */
    C withFacets(final FacetExpression facetExpression);

    /**
     * Returns an EntitySearch with the new facet expression list appended to the existing facets (query parameter {@code facet}).
     * @param facetExpressions the new facet expression list
     * @return an EntitySearch with the existing facets plus the new facet list.
     */
    C plusFacets(final List> facetExpressions);

    /**
     * Returns a new object with the new facet expression appended to the existing facets (query parameter {@code facet}).
     * @param facetExpression the new facet expression
     * @return a new object with the existing facets plus the new facet.
     */
    C plusFacets(final FacetExpression facetExpression);

}