Package com.commercetools.api.models.product_search

Interface ProductSearchMatchingVariants

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

     ProductSearchMatchingVariants productSearchMatchingVariants = ProductSearchMatchingVariants.builder()
             .allMatched(true)
             .plusMatchedVariants(matchedVariantsBuilder -> matchedVariantsBuilder)
             .build()

  • Method Details

    • getAllMatched

      @NotNull @NotNull Boolean getAllMatched()

      true if all Variants of the returned Product match the search query, or if search query does not specify any expression for a Product Variant field.

      false if only a subset of the Product Variants match the search query.

      Is always false for query expressions on Product Variant fields.

      Returns:
      allMatched

    • getMatchedVariants

      @NotNull @Valid @NotNull @Valid List<ProductSearchMatchingVariantEntry> getMatchedVariants()

      Identifiers of the Product Variants that match the search query.

      Empty if all Product Variants of the returned Product match.

      Returns:
      matchedVariants

    • setAllMatched

      void setAllMatched(Boolean allMatched)

      true if all Variants of the returned Product match the search query, or if search query does not specify any expression for a Product Variant field.

      false if only a subset of the Product Variants match the search query.

      Is always false for query expressions on Product Variant fields.

      Parameters:
      allMatched - value to be set

    • setMatchedVariants

      void setMatchedVariants(ProductSearchMatchingVariantEntry... matchedVariants)

      Identifiers of the Product Variants that match the search query.

      Empty if all Product Variants of the returned Product match.

      Parameters:
      matchedVariants - values to be set

    • setMatchedVariants

      void setMatchedVariants(List<ProductSearchMatchingVariantEntry> matchedVariants)

      Identifiers of the Product Variants that match the search query.

      Empty if all Product Variants of the returned Product match.

      Parameters:
      matchedVariants - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductSearchMatchingVariantsBuilder builder()
      builder factory method for ProductSearchMatchingVariants
      Returns:
      builder

    • builder

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

    • withProductSearchMatchingVariants

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