Package com.commercetools.api.models.message

Interface OrderCustomFieldChangedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin, OrderMessagePayload
public interface OrderCustomFieldChangedMessagePayload extends OrderMessagePayload

Generated when an existing Custom Field has been changed using the Set CustomField action.

Example to create an instance using the builder pattern 

     OrderCustomFieldChangedMessagePayload orderCustomFieldChangedMessagePayload = OrderCustomFieldChangedMessagePayload.builder()
             .name("{name}")
             .build()

  • Field Details

    • ORDER_CUSTOM_FIELD_CHANGED

      static final String ORDER_CUSTOM_FIELD_CHANGED
      discriminator value for OrderCustomFieldChangedMessagePayload
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field that changed.

      Returns:
      name

    • getValue

      @NotNull @NotNull Object getValue()

      CustomFieldValue based on the FieldType after the Set CustomField update action.

      Returns:
      value

    • getPreviousValue

      Object getPreviousValue()

      CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

      Returns:
      previousValue

    • setName

      void setName(String name)

      Name of the Custom Field that changed.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      CustomFieldValue based on the FieldType after the Set CustomField update action.

      Parameters:
      value - value to be set

    • setPreviousValue

      void setPreviousValue(Object previousValue)

      CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

      Parameters:
      previousValue - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderCustomFieldChangedMessagePayloadBuilder builder()
      builder factory method for OrderCustomFieldChangedMessagePayload
      Returns:
      builder

    • builder

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

    • withOrderCustomFieldChangedMessagePayload

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