Package com.commercetools.api.models.product_search

Interface ProductSearchProjectionParams

public interface ProductSearchProjectionParams

The query parameters used for data integration with Product Projection parameters.

Example to create an instance using the builder pattern 

     ProductSearchProjectionParams productSearchProjectionParams = ProductSearchProjectionParams.builder()
             .build()

  • Method Details

    • getExpand

      List<String> getExpand()

      Expands a value of type Reference in a ProductProjection. In case the referenced object does not exist, the API returns the non-expanded reference.

      Returns:
      expand

    • getStaged

      Boolean getStaged()

      Set to true to retrieve the staged Product Projection

      Returns:
      staged

    • getPriceCurrency

      String getPriceCurrency()

      The currency used for Product price selection.

      Returns:
      priceCurrency

    • getPriceCountry

      String getPriceCountry()

      The country used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Returns:
      priceCountry

    • getPriceCustomerGroup

      String getPriceCustomerGroup()

      id of an existing CustomerGroup used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Returns:
      priceCustomerGroup

    • getPriceCustomerGroupAssignments

      List<String> getPriceCustomerGroupAssignments()

      IDs of existing CustomerGroups used for Product price selection, when using multiple Customer Groups. It can be used only in conjunction with the priceCurrency parameter.

      Returns:
      priceCustomerGroupAssignments

    • getPriceChannel

      String getPriceChannel()

      id of an existing Channel used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Returns:
      priceChannel

    • getLocaleProjection

      List<String> getLocaleProjection()

      Used for locale-based projection.

      Returns:
      localeProjection

    • getStoreProjection

      String getStoreProjection()

      key of an existing Store. If the Store has defined languages, countries, distributionChannels, or supplyChannels, they are used for projections based on locale, price, and inventory.

      For Projects with active Product Selections, the API does not take the availability of the Product in the specified Store into account.

      Product Tailoring modifies the product information returned in API responses. However, you can only specify query expressions for the original Product data, not for tailored data.

      Returns:
      storeProjection

    • setExpand

      void setExpand(String... expand)

      Expands a value of type Reference in a ProductProjection. In case the referenced object does not exist, the API returns the non-expanded reference.

      Parameters:
      expand - values to be set

    • setExpand

      void setExpand(List<String> expand)

      Expands a value of type Reference in a ProductProjection. In case the referenced object does not exist, the API returns the non-expanded reference.

      Parameters:
      expand - values to be set

    • setStaged

      void setStaged(Boolean staged)

      Set to true to retrieve the staged Product Projection

      Parameters:
      staged - value to be set

    • setPriceCurrency

      void setPriceCurrency(String priceCurrency)

      The currency used for Product price selection.

      Parameters:
      priceCurrency - value to be set

    • setPriceCountry

      void setPriceCountry(String priceCountry)

      The country used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Parameters:
      priceCountry - value to be set

    • setPriceCustomerGroup

      void setPriceCustomerGroup(String priceCustomerGroup)

      id of an existing CustomerGroup used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Parameters:
      priceCustomerGroup - value to be set

    • setPriceCustomerGroupAssignments

      void setPriceCustomerGroupAssignments(String... priceCustomerGroupAssignments)

      IDs of existing CustomerGroups used for Product price selection, when using multiple Customer Groups. It can be used only in conjunction with the priceCurrency parameter.

      Parameters:
      priceCustomerGroupAssignments - values to be set

    • setPriceCustomerGroupAssignments

      void setPriceCustomerGroupAssignments(List<String> priceCustomerGroupAssignments)

      IDs of existing CustomerGroups used for Product price selection, when using multiple Customer Groups. It can be used only in conjunction with the priceCurrency parameter.

      Parameters:
      priceCustomerGroupAssignments - values to be set

    • setPriceChannel

      void setPriceChannel(String priceChannel)

      id of an existing Channel used for Product price selection. It can be used only in conjunction with the priceCurrency parameter.

      Parameters:
      priceChannel - value to be set

    • setLocaleProjection

      void setLocaleProjection(String... localeProjection)

      Used for locale-based projection.

      Parameters:
      localeProjection - values to be set

    • setLocaleProjection

      void setLocaleProjection(List<String> localeProjection)

      Used for locale-based projection.

      Parameters:
      localeProjection - values to be set

    • setStoreProjection

      void setStoreProjection(String storeProjection)

      key of an existing Store. If the Store has defined languages, countries, distributionChannels, or supplyChannels, they are used for projections based on locale, price, and inventory.

      For Projects with active Product Selections, the API does not take the availability of the Product in the specified Store into account.

      Product Tailoring modifies the product information returned in API responses. However, you can only specify query expressions for the original Product data, not for tailored data.

      Parameters:
      storeProjection - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSearchProjectionParams copyDeep()

    • deepCopy

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

    • builder

      static ProductSearchProjectionParamsBuilder builder()
      builder factory method for ProductSearchProjectionParams
      Returns:
      builder

    • builder

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

    • withProductSearchProjectionParams

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