Package com.commercetools.api.models.message

Interface CustomerAddressCustomFieldChangedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface CustomerAddressCustomFieldChangedMessagePayload extends MessagePayload

Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.

Example to create an instance using the builder pattern 

     CustomerAddressCustomFieldChangedMessagePayload customerAddressCustomFieldChangedMessagePayload = CustomerAddressCustomFieldChangedMessagePayload.builder()
             .name("{name}")
             .build()

  • Field Details

    • CUSTOMER_ADDRESS_CUSTOM_FIELD_CHANGED

      static final String CUSTOMER_ADDRESS_CUSTOM_FIELD_CHANGED
      discriminator value for CustomerAddressCustomFieldChangedMessagePayload
      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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.

      Returns:
      previousValue

    • getAddressId

      String getAddressId()

      id of the Address of which the Custom Field was changed.

      Returns:
      addressId

    • 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 Customer Address before, a Customer Address Custom Field Added Message is generated instead.

      Parameters:
      previousValue - value to be set

    • setAddressId

      void setAddressId(String addressId)

      id of the Address of which the Custom Field was changed.

      Parameters:
      addressId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomerAddressCustomFieldChangedMessagePayloadBuilder builder()
      builder factory method for CustomerAddressCustomFieldChangedMessagePayload
      Returns:
      builder

    • builder

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

    • withCustomerAddressCustomFieldChangedMessagePayload

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