Interface OrderCustomFieldChangedMessagePayload
- All Superinterfaces:
MessagePayload
,MessagePayloadMixin
,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 Summary
FieldsModifier and TypeFieldDescriptionstatic final String
discriminator value for OrderCustomFieldChangedMessagePayload -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for OrderCustomFieldChangedMessagePayloadbuilder
(OrderCustomFieldChangedMessagePayload template) create builder for OrderCustomFieldChangedMessagePayload instancecopyDeep()
factory method to create a deep copy of OrderCustomFieldChangedMessagePayload@NotNull String
getName()
Name of the Custom Field that changed.@NotNull Object
getValue()
of()
factory methodof
(OrderCustomFieldChangedMessagePayload template) factory method to create a shallow copy OrderCustomFieldChangedMessagePayloadvoid
Name of the Custom Field that changed.void
setPreviousValue
(Object previousValue) void
static com.fasterxml.jackson.core.type.TypeReference<OrderCustomFieldChangedMessagePayload>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.message.MessagePayload
getType, withMessagePayload
Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin
as
Methods inherited from interface com.commercetools.api.models.message.OrderMessagePayload
withOrderMessagePayload
-
Field Details
-
ORDER_CUSTOM_FIELD_CHANGED
discriminator value for OrderCustomFieldChangedMessagePayload- See Also:
-
-
Method Details
-
getName
Name of the Custom Field that changed.
- Returns:
- name
-
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
Name of the Custom Field that changed.
- Parameters:
name
- value to be set
-
setValue
CustomFieldValue based on the FieldType after the Set CustomField update action.
- Parameters:
value
- value to be set
-
setPreviousValue
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
factory method- Returns:
- instance of OrderCustomFieldChangedMessagePayload
-
of
factory method to create a shallow copy OrderCustomFieldChangedMessagePayload- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
OrderCustomFieldChangedMessagePayload copyDeep()- Specified by:
copyDeep
in interfaceMessagePayload
- Specified by:
copyDeep
in interfaceOrderMessagePayload
-
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
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
-