Package com.commercetools.history.models.change

Interface SetKeyChange

All Superinterfaces:
Change
public interface SetKeyChange extends Change

Change triggered by the following update actions:

  • Set Key on Cart Discounts.
  • Set Key on Categories.
  • Set Key on Customers.
  • Set Key on Customer Groups.
  • Set Key on Payments.
  • Set Key on Products.
  • Set Key on Product Discounts.
  • Set Key on Product Selections.
  • Set Key on Product Types.
  • Set Key on Reviews.
  • Set Key on Shopping Lists.
  • Set Key on Zones.
Example to create an instance using the builder pattern 

     SetKeyChange setKeyChange = SetKeyChange.builder()
             .change("{change}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .build()

  • Field Details

  • 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 @NotNull String getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull String getNextValue()

      Value after the change.

      Returns:
      nextValue

    • setChange

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

    • setPreviousValue

      void setPreviousValue(String previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(String nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SetKeyChangeBuilder builder()
      builder factory method for SetKeyChange
      Returns:
      builder

    • builder

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

    • withSetKeyChange

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