Package com.commercetools.history.models.change

Interface SetCustomFieldChange

All Superinterfaces:
Change
public interface SetCustomFieldChange extends Change

Change triggered by the following update actions:

  • Set CustomField on Cart Discounts.
  • Set CustomField on Categories.
  • Set CustomField on Channels.
  • Set CustomField on Customers.
  • Set CustomField on Customer Groups.
  • Set CustomField on Discount Codes.
  • Set CustomField on Inventories.
  • Set CustomField on Orders.
  • Set CustomField on Order Edits.
  • Set CustomField on Payments.
  • Set CustomField on Product Selections.
  • Set CustomField on Quotes.
  • Set CustomField on Quote Requests.
  • Set CustomField on Reviews.
  • Set CustomField on Shopping Lists.
  • Set CustomField on Staged Orders.
  • Set CustomField on Staged Quotes.
  • Set CustomField on Stores.
Example to create an instance using the builder pattern 

     SetCustomFieldChange setCustomFieldChange = SetCustomFieldChange.builder()
             .change("{change}")
             .name("{name}")
             .customTypeId("{customTypeId}")
             .build()

  • Field Details

    • SET_CUSTOM_FIELD_CHANGE

      static final String SET_CUSTOM_FIELD_CHANGE
      discriminator value for SetCustomFieldChange
      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

    • getPreviousValue

      @NotNull @NotNull Object getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull Object getNextValue()

      Value after the change.

      Returns:
      nextValue

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getCustomTypeId

      @NotNull @NotNull String getCustomTypeId()

      id of the referenced Type.

      Returns:
      customTypeId

    • setChange

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

    • setPreviousValue

      void setPreviousValue(Object previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(Object nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setCustomTypeId

      void setCustomTypeId(String customTypeId)

      id of the referenced Type.

      Parameters:
      customTypeId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SetCustomFieldChangeBuilder builder()
      builder factory method for SetCustomFieldChange
      Returns:
      builder

    • builder

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

    • withSetCustomFieldChange

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