Package com.commercetools.history.models.change

Interface SetPriceKeyChange

All Superinterfaces:
Change
public interface SetPriceKeyChange extends Change

Change triggered by the Set Price Key update action.

Example to create an instance using the builder pattern 

     SetPriceKeyChange setPriceKeyChange = SetPriceKeyChange.builder()
             .change("{change}")
             .catalogData("{catalogData}")
             .variant("{variant}")
             .priceId("{priceId}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .build()

  • Field Details

    • SET_PRICE_KEY_CHANGE

      static final String SET_PRICE_KEY_CHANGE
      discriminator value for SetPriceKeyChange
      See Also:

  • Method Details

    • 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

    • 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

    • getCatalogData

      @NotNull @NotNull String getCatalogData()

      Product data that was updated.

      Returns:
      catalogData

    • getVariant

      @NotNull @NotNull String getVariant()

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Returns:
      variant

    • getPriceId

      @NotNull @NotNull String getPriceId()

      id of the Embedded Price.

      Returns:
      priceId

    • 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

    • setCatalogData

      void setCatalogData(String catalogData)

      Product data that was updated.

      Parameters:
      catalogData - value to be set

    • setVariant

      void setVariant(String variant)

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Parameters:
      variant - value to be set

    • setPriceId

      void setPriceId(String priceId)

      id of the Embedded Price.

      Parameters:
      priceId - 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 SetPriceKeyChange of()
      factory method
      Returns:
      instance of SetPriceKeyChange

    • of

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

    • copyDeep

      SetPriceKeyChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

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

    • builder

      static SetPriceKeyChangeBuilder builder()
      builder factory method for SetPriceKeyChange
      Returns:
      builder

    • builder

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

    • withSetPriceKeyChange

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