Package com.commercetools.api.models.product_search

Interface ProductSearchFacetRangesValue

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

     ProductSearchFacetRangesValue productSearchFacetRangesValue = ProductSearchFacetRangesValue.builder()
             .name("{name}")
             .field("{field}")
             .plusRanges(rangesBuilder -> rangesBuilder)
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the ranges facet to appear in the ProductSearchFacetResultBucket.

      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 search result before calculating the facet.

      Returns:
      filter

    • getLevel

      ProductSearchFacetCountLevelEnum getLevel()

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

      Returns:
      level

    • getField

      @NotNull @NotNull String getField()

      The searchable Product field to facet on.

      Returns:
      field

    • getRanges

      @NotNull @Valid @NotNull @Valid List<ProductSearchFacetRangesFacetRange> getRanges()

      Define ranges for the facet.

      Returns:
      ranges

    • getLanguage

      String getLanguage()

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Returns:
      language

    • getFieldType

      SearchFieldType getFieldType()

      If the field is not standard, this must be the Attribute type.

      Returns:
      fieldType

    • setName

      void setName(String name)

      Name of the ranges facet to appear in the ProductSearchFacetResultBucket.

      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 search 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

    • setField

      void setField(String field)

      The searchable Product field to facet on.

      Parameters:
      field - value to be set

    • setRanges

      void setRanges(ProductSearchFacetRangesFacetRange... ranges)

      Define ranges for the facet.

      Parameters:
      ranges - values to be set

    • setRanges

      void setRanges(List<ProductSearchFacetRangesFacetRange> ranges)

      Define ranges for the facet.

      Parameters:
      ranges - values to be set

    • setLanguage

      void setLanguage(String language)

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Parameters:
      language - value to be set

    • setFieldType

      void setFieldType(SearchFieldType fieldType)

      If the field is not standard, this must be the Attribute type.

      Parameters:
      fieldType - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductSearchFacetRangesValueBuilder builder()
      builder factory method for ProductSearchFacetRangesValue
      Returns:
      builder

    • builder

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

    • withProductSearchFacetRangesValue

      default <T> T withProductSearchFacetRangesValue(Function<ProductSearchFacetRangesValue,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<ProductSearchFacetRangesValue> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference