Package com.commercetools.api.models.message

Interface OrderCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderCustomFieldAddedMessagePayload
extends OrderMessagePayload

Generated after adding a Custom Field using the Set CustomField.

Example to create an instance using the builder pattern

     OrderCustomFieldAddedMessagePayload orderCustomFieldAddedMessagePayload = OrderCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderCustomFieldAddedMessagePayloadBuilder	builder()	builder factory method for OrderCustomFieldAddedMessagePayload
static OrderCustomFieldAddedMessagePayloadBuilder	builder(OrderCustomFieldAddedMessagePayload template)	create builder for OrderCustomFieldAddedMessagePayload instance
OrderCustomFieldAddedMessagePayload	copyDeep()
static OrderCustomFieldAddedMessagePayload	deepCopy(OrderCustomFieldAddedMessagePayload template)	factory method to create a deep copy of OrderCustomFieldAddedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static OrderCustomFieldAddedMessagePayload	of()	factory method
static OrderCustomFieldAddedMessagePayload	of(OrderCustomFieldAddedMessagePayload template)	factory method to create a shallow copy OrderCustomFieldAddedMessagePayload
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<OrderCustomFieldAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCustomFieldAddedMessagePayload(Function<OrderCustomFieldAddedMessagePayload,T> helper)	accessor map function

Methods 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_ADDED

static final String ORDER_CUSTOM_FIELD_ADDED

discriminator value for OrderCustomFieldAddedMessagePayload

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 OrderCustomFieldAddedMessagePayload of()

factory method

Returns:

instance of OrderCustomFieldAddedMessagePayload

of

static OrderCustomFieldAddedMessagePayload of(OrderCustomFieldAddedMessagePayload template)

factory method to create a shallow copy OrderCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderCustomFieldAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderCustomFieldAddedMessagePayload deepCopy(@Nullable
 OrderCustomFieldAddedMessagePayload template)

factory method to create a deep copy of OrderCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for OrderCustomFieldAddedMessagePayload

Returns:

builder

builder

static OrderCustomFieldAddedMessagePayloadBuilder builder(OrderCustomFieldAddedMessagePayload template)

create builder for OrderCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderCustomFieldAddedMessagePayload

default <T> T withOrderCustomFieldAddedMessagePayload(Function<OrderCustomFieldAddedMessagePayload,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<OrderCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference