Package com.commercetools.api.models.message

Interface OrderCustomFieldChangedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

All Known Implementing Classes:

OrderCustomFieldChangedMessageImpl

public interface OrderCustomFieldChangedMessage
extends OrderMessage

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

Example to create an instance using the builder pattern

     OrderCustomFieldChangedMessage orderCustomFieldChangedMessage = OrderCustomFieldChangedMessage.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 Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_CUSTOM_FIELD_CHANGED	discriminator value for OrderCustomFieldChangedMessage

Method Summary

Modifier and Type	Method	Description
static OrderCustomFieldChangedMessageBuilder	builder()	builder factory method for OrderCustomFieldChangedMessage
static OrderCustomFieldChangedMessageBuilder	builder(OrderCustomFieldChangedMessage template)	create builder for OrderCustomFieldChangedMessage instance
static OrderCustomFieldChangedMessage	deepCopy(OrderCustomFieldChangedMessage template)	factory method to create a deep copy of OrderCustomFieldChangedMessage
@NotNull String	getName()	Name of the Custom Field that has been changed.
Object	getPreviousValue()	CustomFieldValue based on the FieldType before the Set CustomField update action.
@NotNull Object	getValue()	CustomFieldValue based on the FieldType after the Set Custom Field update action.
static OrderCustomFieldChangedMessage	of()	factory method
static OrderCustomFieldChangedMessage	of(OrderCustomFieldChangedMessage template)	factory method to create a shallow copy OrderCustomFieldChangedMessage
void	setName(String name)	Name of the Custom Field that has been changed.
void	setPreviousValue(Object previousValue)	CustomFieldValue based on the FieldType before the Set CustomField update action.
void	setValue(Object value)	CustomFieldValue based on the FieldType after the Set Custom Field update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderCustomFieldChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCustomFieldChangedMessage(Function<OrderCustomFieldChangedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Methods inherited from interface com.commercetools.api.models.message.OrderMessage

withOrderMessage

Field Details

ORDER_CUSTOM_FIELD_CHANGED

static final String ORDER_CUSTOM_FIELD_CHANGED

discriminator value for OrderCustomFieldChangedMessage

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that has been changed.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

CustomFieldValue based on the FieldType after the Set Custom Field 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 has been changed.

Parameters:

name - value to be set

setValue

void setValue(Object value)

CustomFieldValue based on the FieldType after the Set Custom Field 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 OrderCustomFieldChangedMessage of()

factory method

Returns:

instance of OrderCustomFieldChangedMessage

of

static OrderCustomFieldChangedMessage of(OrderCustomFieldChangedMessage template)

factory method to create a shallow copy OrderCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderCustomFieldChangedMessage deepCopy(@Nullable
 OrderCustomFieldChangedMessage template)

factory method to create a deep copy of OrderCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderCustomFieldChangedMessageBuilder builder()

builder factory method for OrderCustomFieldChangedMessage

Returns:

builder

builder

static OrderCustomFieldChangedMessageBuilder builder(OrderCustomFieldChangedMessage template)

create builder for OrderCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderCustomFieldChangedMessage

default <T> T withOrderCustomFieldChangedMessage(Function<OrderCustomFieldChangedMessage,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<OrderCustomFieldChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference