Package com.commercetools.api.models.message

Interface OrderCustomFieldAddedMessage

All Superinterfaces:
BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>
public interface OrderCustomFieldAddedMessage extends OrderMessage

Generated after adding a Custom Field using the Set CustomField.

Example to create an instance using the builder pattern 

     OrderCustomFieldAddedMessage orderCustomFieldAddedMessage = OrderCustomFieldAddedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .name("{name}")
             .build()

  • Field Details

    • ORDER_CUSTOM_FIELD_ADDED

      static final String ORDER_CUSTOM_FIELD_ADDED
      discriminator value for OrderCustomFieldAddedMessage
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field that was added.

      Returns:
      name

    • getValue

      @NotNull @NotNull Object getValue()

      The added CustomFieldValue based on the FieldType.

      Returns:
      value

    • setName

      void setName(String name)

      Name of the Custom Field that was added.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      The added CustomFieldValue based on the FieldType.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderCustomFieldAddedMessageBuilder builder()
      builder factory method for OrderCustomFieldAddedMessage
      Returns:
      builder

    • builder

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

    • withOrderCustomFieldAddedMessage

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