Package com.commercetools.history.models.change

Interface SetCategoryOrderHintChange

All Superinterfaces:
Change
public interface SetCategoryOrderHintChange extends Change

Change triggered by the Set Category Order Hint update action.

Example to create an instance using the builder pattern 

     SetCategoryOrderHintChange setCategoryOrderHintChange = SetCategoryOrderHintChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .catalogData("{catalogData}")
             .categoryId("{categoryId}")
             .build()

  • Field Details

    • SET_CATEGORY_ORDER_HINT_CHANGE

      static final String SET_CATEGORY_ORDER_HINT_CHANGE
      discriminator value for SetCategoryOrderHintChange
      See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • getPreviousValue

      @NotNull @Valid @NotNull @Valid CategoryOrderHints getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid CategoryOrderHints getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getCatalogData

      @NotNull @NotNull String getCatalogData()
      Returns:
      catalogData

    • getCategoryId

      @NotNull @NotNull String getCategoryId()

      id of the updated Category.

      Returns:
      categoryId

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • setPreviousValue

      void setPreviousValue(CategoryOrderHints previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(CategoryOrderHints nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setCatalogData

      void setCatalogData(String catalogData)
      Parameters:
      catalogData - value to be set

    • setCategoryId

      void setCategoryId(String categoryId)

      id of the updated Category.

      Parameters:
      categoryId - value to be set

    • of

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

    • of

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

    • copyDeep

      SetCategoryOrderHintChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetCategoryOrderHintChangeBuilder builder()
      builder factory method for SetCategoryOrderHintChange
      Returns:
      builder

    • builder

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

    • withSetCategoryOrderHintChange

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