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 Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_CUSTOM_FIELD_ADDED	discriminator value for OrderCustomFieldAddedMessage

Method Summary

Modifier and Type	Method	Description
static OrderCustomFieldAddedMessageBuilder	builder()	builder factory method for OrderCustomFieldAddedMessage
static OrderCustomFieldAddedMessageBuilder	builder(OrderCustomFieldAddedMessage template)	create builder for OrderCustomFieldAddedMessage instance
OrderCustomFieldAddedMessage	copyDeep()
static OrderCustomFieldAddedMessage	deepCopy(OrderCustomFieldAddedMessage template)	factory method to create a deep copy of OrderCustomFieldAddedMessage
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static OrderCustomFieldAddedMessage	of()	factory method
static OrderCustomFieldAddedMessage	of(OrderCustomFieldAddedMessage template)	factory method to create a shallow copy OrderCustomFieldAddedMessage
void	setName(String name)	Name of the Custom Field that was added.
void	setValue(Object value)	The added CustomFieldValue based on the FieldType.
static com.fasterxml.jackson.core.type.TypeReference<OrderCustomFieldAddedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCustomFieldAddedMessage(Function<OrderCustomFieldAddedMessage,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_ADDED

static final String ORDER_CUSTOM_FIELD_ADDED

discriminator value for OrderCustomFieldAddedMessage

See Also:

• Constant Field Values

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

copyDeep

OrderCustomFieldAddedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

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