Package com.commercetools.api.models.product_search

Interface ProductSearchResult

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

     ProductSearchResult productSearchResult = ProductSearchResult.builder()
             .id("{id}")
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      id of the Product that matches the search query.

      Returns:
      id

    • getMatchingVariants

      @Valid @Valid ProductSearchMatchingVariants getMatchingVariants()

      Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

      Returns:
      matchingVariants

    • getProductProjection

      @Valid @Valid ProductProjection getProductProjection()

      Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

      Returns:
      productProjection

    • setId

      void setId(String id)

      id of the Product that matches the search query.

      Parameters:
      id - value to be set

    • setMatchingVariants

      void setMatchingVariants(ProductSearchMatchingVariants matchingVariants)

      Information about which Product Variants match the search query. Only present if markMatchingVariants is set to true in the ProductSearchRequest.

      Parameters:
      matchingVariants - value to be set

    • setProductProjection

      void setProductProjection(ProductProjection productProjection)

      Projected data of the Product with id. Only present if data integration with Product Projection parameters is requested.

      Parameters:
      productProjection - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSearchResult copyDeep()

    • deepCopy

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

    • builder

      static ProductSearchResultBuilder builder()
      builder factory method for ProductSearchResult
      Returns:
      builder

    • builder

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

    • withProductSearchResult

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