Package com.commercetools.api.models.product_search

Interface ProductSearchFacetStatsValue

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

     ProductSearchFacetStatsValue productSearchFacetStatsValue = ProductSearchFacetStatsValue.builder()
             .name("{name}")
             .field("{field}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the stats facet to appear in the ProductSearchFacetResultStats.

      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

    • getField

      @NotNull @NotNull String getField()

      The searchable Product field to facet on.

      Returns:
      field

    • 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 stats facet to appear in the ProductSearchFacetResultStats.

      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

    • setField

      void setField(String field)

      The searchable Product field to facet on.

      Parameters:
      field - 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 ProductSearchFacetStatsValue of()
      factory method
      Returns:
      instance of ProductSearchFacetStatsValue

    • of

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

    • copyDeep

      ProductSearchFacetStatsValue copyDeep()

    • deepCopy

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

    • builder

      static ProductSearchFacetStatsValueBuilder builder()
      builder factory method for ProductSearchFacetStatsValue
      Returns:
      builder

    • builder

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

    • withProductSearchFacetStatsValue

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