Package com.commercetools.api.models.product_search

Class ProductSearchProjectionParamsBuilder

java.lang.Object
com.commercetools.api.models.product_search.ProductSearchProjectionParamsBuilder
All Implemented Interfaces:
Builder<ProductSearchProjectionParams>
public class ProductSearchProjectionParamsBuilder extends Object implements Builder<ProductSearchProjectionParams>
ProductSearchProjectionParamsBuilder
Example to create an instance using the builder pattern 

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

  • Constructor Details

    • ProductSearchProjectionParamsBuilder

      public ProductSearchProjectionParamsBuilder()

  • Method Details

    • expand

      public ProductSearchProjectionParamsBuilder expand(@Nullable 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 - value to be set
      Returns:
      Builder

    • expand

      public ProductSearchProjectionParamsBuilder expand(@Nullable 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 - value to be set
      Returns:
      Builder

    • plusExpand

      public ProductSearchProjectionParamsBuilder plusExpand(@Nullable 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 - value to be set
      Returns:
      Builder

    • staged

      public ProductSearchProjectionParamsBuilder staged(@Nullable Boolean staged)

      Set to true to retrieve the staged Product Projection

      Parameters:
      staged - value to be set
      Returns:
      Builder

    • priceCurrency

      public ProductSearchProjectionParamsBuilder priceCurrency(@Nullable String priceCurrency)

      The currency used for Product price selection.

      Parameters:
      priceCurrency - value to be set
      Returns:
      Builder

    • priceCountry

      public ProductSearchProjectionParamsBuilder priceCountry(@Nullable 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
      Returns:
      Builder

    • priceCustomerGroup

      public ProductSearchProjectionParamsBuilder priceCustomerGroup(@Nullable 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
      Returns:
      Builder

    • priceCustomerGroupAssignments

      public ProductSearchProjectionParamsBuilder priceCustomerGroupAssignments(@Nullable 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 - value to be set
      Returns:
      Builder

    • priceCustomerGroupAssignments

      public ProductSearchProjectionParamsBuilder priceCustomerGroupAssignments(@Nullable 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 - value to be set
      Returns:
      Builder

    • plusPriceCustomerGroupAssignments

      public ProductSearchProjectionParamsBuilder plusPriceCustomerGroupAssignments(@Nullable 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 - value to be set
      Returns:
      Builder

    • priceChannel

      public ProductSearchProjectionParamsBuilder priceChannel(@Nullable 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
      Returns:
      Builder

    • localeProjection

      public ProductSearchProjectionParamsBuilder localeProjection(@Nullable String... localeProjection)

      Used for locale-based projection.

      Parameters:
      localeProjection - value to be set
      Returns:
      Builder

    • localeProjection

      public ProductSearchProjectionParamsBuilder localeProjection(@Nullable List<String> localeProjection)

      Used for locale-based projection.

      Parameters:
      localeProjection - value to be set
      Returns:
      Builder

    • plusLocaleProjection

      public ProductSearchProjectionParamsBuilder plusLocaleProjection(@Nullable String... localeProjection)

      Used for locale-based projection.

      Parameters:
      localeProjection - value to be set
      Returns:
      Builder

    • storeProjection

      public ProductSearchProjectionParamsBuilder storeProjection(@Nullable 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, but evaluating query expressions is restricted to the original product information.

      Parameters:
      storeProjection - value to be set
      Returns:
      Builder

    • getExpand

      @Nullable public 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

      @Nullable public Boolean getStaged()

      Set to true to retrieve the staged Product Projection

      Returns:
      staged

    • getPriceCurrency

      @Nullable public String getPriceCurrency()

      The currency used for Product price selection.

      Returns:
      priceCurrency

    • getPriceCountry

      @Nullable public String getPriceCountry()

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

      Returns:
      priceCountry

    • getPriceCustomerGroup

      @Nullable public 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

      @Nullable public 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

      @Nullable public 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

      @Nullable public List<String> getLocaleProjection()

      Used for locale-based projection.

      Returns:
      localeProjection

    • getStoreProjection

      @Nullable public 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, but evaluating query expressions is restricted to the original product information.

      Returns:
      storeProjection

    • build

      public ProductSearchProjectionParams build()
      builds ProductSearchProjectionParams with checking for non-null required values
      Specified by:
      build in interface Builder<ProductSearchProjectionParams>
      Returns:
      ProductSearchProjectionParams

    • buildUnchecked

      public ProductSearchProjectionParams buildUnchecked()
      builds ProductSearchProjectionParams without checking for non-null required values
      Returns:
      ProductSearchProjectionParams

    • of

      public static ProductSearchProjectionParamsBuilder of()
      factory method for an instance of ProductSearchProjectionParamsBuilder
      Returns:
      builder

    • of

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