Package com.commercetools.api.models.product

Interface CategoryOrderHints

public interface CategoryOrderHints

JSON object where the keys are Category id, and the values are order hint values: strings representing a number between 0 and 1, but not ending in 0. Order hints allow controlling the order of Products and how they appear in Categories. Products without order hints have an order score below 0. Order hints are not unique. If a subset of Products have the same value for order hint in a specific category, the behavior is undetermined.

Example to create an instance using the builder pattern 

     CategoryOrderHints categoryOrderHints = CategoryOrderHints.builder()
             ./^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/("{/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/}")
             .build()

  • Method Details

    • values

      @NotNull @NotNull Map<String,String> values()

      A string representing a number between 0 and 1, but not ending in 0.

      Returns:
      map of the pattern property values

    • setValue

      void setValue(String key, String value)

      A string representing a number between 0 and 1, but not ending in 0.

      Parameters:
      key - property name
      value - property value

    • of

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

    • of

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

    • copyDeep

      CategoryOrderHints copyDeep()

    • deepCopy

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

    • builder

      static CategoryOrderHintsBuilder builder()
      builder factory method for CategoryOrderHints
      Returns:
      builder

    • builder

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

    • withCategoryOrderHints

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