Package com.commercetools.history.models.change

Interface RemoveEnumValuesChange

All Superinterfaces:
Change
public interface RemoveEnumValuesChange extends Change

Change triggered by the Remove EnumValues from AttributeDefinition update action.

Example to create an instance using the builder pattern 

     RemoveEnumValuesChange removeEnumValuesChange = RemoveEnumValuesChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .attributeName("{attributeName}")
             .build()

  • Field Details

    • REMOVE_ENUM_VALUES_CHANGE

      static final String REMOVE_ENUM_VALUES_CHANGE
      discriminator value for RemoveEnumValuesChange
      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 EnumValue getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getAttributeName

      @NotNull @NotNull String getAttributeName()

      Name of the updated AttributeDefinition.

      Returns:
      attributeName

    • 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 - value to be set

    • setAttributeName

      void setAttributeName(String attributeName)

      Name of the updated AttributeDefinition.

      Parameters:
      attributeName - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static RemoveEnumValuesChangeBuilder builder()
      builder factory method for RemoveEnumValuesChange
      Returns:
      builder

    • builder

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

    • withRemoveEnumValuesChange

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