Package com.commercetools.api.models.product

Class ProductSetCategoryOrderHintActionBuilder

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

     ProductSetCategoryOrderHintAction productSetCategoryOrderHintAction = ProductSetCategoryOrderHintAction.builder()
             .categoryId("{categoryId}")
             .build()

  • Constructor Details

    • ProductSetCategoryOrderHintActionBuilder

      public ProductSetCategoryOrderHintActionBuilder()

  • Method Details

    • categoryId

      public ProductSetCategoryOrderHintActionBuilder categoryId(String categoryId)

      The id of the Category to add the orderHint. If this Category is not assigned to the Product, an InvalidOperation error is returned.

      Parameters:
      categoryId - value to be set
      Returns:
      Builder

    • orderHint

      public ProductSetCategoryOrderHintActionBuilder orderHint(@Nullable String orderHint)

      A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If omitted, any existing value is removed.

      Parameters:
      orderHint - value to be set
      Returns:
      Builder

    • staged

      public ProductSetCategoryOrderHintActionBuilder staged(@Nullable Boolean staged)

      Whether only the staged categoryOrderHints is updated. If false, both the current and staged categoryOrderHints are updated.

      Parameters:
      staged - value to be set
      Returns:
      Builder

    • getCategoryId

      public String getCategoryId()

      The id of the Category to add the orderHint. If this Category is not assigned to the Product, an InvalidOperation error is returned.

      Returns:
      categoryId

    • getOrderHint

      @Nullable public String getOrderHint()

      A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If omitted, any existing value is removed.

      Returns:
      orderHint

    • getStaged

      @Nullable public Boolean getStaged()

      Whether only the staged categoryOrderHints is updated. If false, both the current and staged categoryOrderHints are updated.

      Returns:
      staged

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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