Package com.commercetools.history.models.change

Interface ChangeEnumValueOrderChange

All Superinterfaces:
Change
public interface ChangeEnumValueOrderChange extends Change

Change triggered by the Change the order of EnumValues update action.

Example to create an instance using the builder pattern 

     ChangeEnumValueOrderChange changeEnumValueOrderChange = ChangeEnumValueOrderChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .fieldName("{fieldName}")
             .build()

  • Field Details

    • CHANGE_ENUM_VALUE_ORDER_CHANGE

      static final String CHANGE_ENUM_VALUE_ORDER_CHANGE
      discriminator value for ChangeEnumValueOrderChange
      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 List<EnumValue> getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @Valid @NotNull @Valid List<EnumValue> getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getFieldName

      @NotNull @NotNull String getFieldName()

      Name of the updated FieldDefinition.

      Returns:
      fieldName

    • setChange

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

    • setPreviousValue

      void setPreviousValue(EnumValue... previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setPreviousValue

      void setPreviousValue(List<EnumValue> previousValue)

      Value before the change.

      Parameters:
      previousValue - values to be set

    • setNextValue

      void setNextValue(EnumValue... nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setNextValue

      void setNextValue(List<EnumValue> nextValue)

      Value after the change.

      Parameters:
      nextValue - values to be set

    • setFieldName

      void setFieldName(String fieldName)

      Name of the updated FieldDefinition.

      Parameters:
      fieldName - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ChangeEnumValueOrderChangeBuilder builder()
      builder factory method for ChangeEnumValueOrderChange
      Returns:
      builder

    • builder

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

    • withChangeEnumValueOrderChange

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