Package com.commercetools.api.models.product_search

Interface ProductSearchFacetCountValue

public interface ProductSearchFacetCountValue
ProductSearchFacetCountValue
Example to create an instance using the builder pattern 

     ProductSearchFacetCountValue productSearchFacetCountValue = ProductSearchFacetCountValue.builder()
             .name("{name}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the count facet to appear in the ProductSearchFacetResultCount.

      Returns:
      name

    • getScope

      ProductSearchFacetScopeEnum getScope()

      Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

      Returns:
      scope

    • getFilter

      @Valid @Valid SearchQuery getFilter()

      Additional filtering expression to apply to the facet result before calculating the facet.

      Returns:
      filter

    • getLevel

      ProductSearchFacetCountLevelEnum getLevel()

      Specify whether to count Products (products) or Product Variants (variants).

      Returns:
      level

    • setName

      void setName(String name)

      Name of the count facet to appear in the ProductSearchFacetResultCount.

      Parameters:
      name - value to be set

    • setScope

      void setScope(ProductSearchFacetScopeEnum scope)

      Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

      Parameters:
      scope - value to be set

    • setFilter

      void setFilter(SearchQuery filter)

      Additional filtering expression to apply to the facet result before calculating the facet.

      Parameters:
      filter - value to be set

    • setLevel

      void setLevel(ProductSearchFacetCountLevelEnum level)

      Specify whether to count Products (products) or Product Variants (variants).

      Parameters:
      level - value to be set

    • of

      static ProductSearchFacetCountValue of()
      factory method
      Returns:
      instance of ProductSearchFacetCountValue

    • of

      static ProductSearchFacetCountValue of(ProductSearchFacetCountValue template)
      factory method to create a shallow copy ProductSearchFacetCountValue
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ProductSearchFacetCountValue copyDeep()

    • deepCopy

      @Nullable static ProductSearchFacetCountValue deepCopy(@Nullable ProductSearchFacetCountValue template)
      factory method to create a deep copy of ProductSearchFacetCountValue
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProductSearchFacetCountValueBuilder builder()
      builder factory method for ProductSearchFacetCountValue
      Returns:
      builder

    • builder

      static ProductSearchFacetCountValueBuilder builder(ProductSearchFacetCountValue template)
      create builder for ProductSearchFacetCountValue instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProductSearchFacetCountValue

      default <T> T withProductSearchFacetCountValue(Function<ProductSearchFacetCountValue,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductSearchFacetCountValue> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference