Package com.commercetools.api.models.message

Interface DeliveryCustomFieldChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryCustomFieldChangedMessagePayload
extends OrderMessagePayload

Generated when an existing Custom Field on a Delivery has been changed using the Set CustomField update action.

Example to create an instance using the builder pattern

     DeliveryCustomFieldChangedMessagePayload deliveryCustomFieldChangedMessagePayload = DeliveryCustomFieldChangedMessagePayload.builder()
             .name("{name}")
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_CUSTOM_FIELD_CHANGED	discriminator value for DeliveryCustomFieldChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomFieldChangedMessagePayloadBuilder	builder()	builder factory method for DeliveryCustomFieldChangedMessagePayload
static DeliveryCustomFieldChangedMessagePayloadBuilder	builder(DeliveryCustomFieldChangedMessagePayload template)	create builder for DeliveryCustomFieldChangedMessagePayload instance
DeliveryCustomFieldChangedMessagePayload	copyDeep()
static DeliveryCustomFieldChangedMessagePayload	deepCopy(DeliveryCustomFieldChangedMessagePayload template)	factory method to create a deep copy of DeliveryCustomFieldChangedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull String	getName()	Name of the Custom Field that 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 CustomField update action.
static DeliveryCustomFieldChangedMessagePayload	of()	factory method
static DeliveryCustomFieldChangedMessagePayload	of(DeliveryCustomFieldChangedMessagePayload template)	factory method to create a shallow copy DeliveryCustomFieldChangedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setName(String name)	Name of the Custom Field that 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 CustomField update action.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryCustomFieldChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomFieldChangedMessagePayload(Function<DeliveryCustomFieldChangedMessagePayload,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

DELIVERY_CUSTOM_FIELD_CHANGED

static final String DELIVERY_CUSTOM_FIELD_CHANGED

discriminator value for DeliveryCustomFieldChangedMessagePayload

See Also:

• Constant Field Values

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

Returns:

previousValue

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

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

Parameters:

previousValue - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

of

static DeliveryCustomFieldChangedMessagePayload of()

factory method

Returns:

instance of DeliveryCustomFieldChangedMessagePayload

of

static DeliveryCustomFieldChangedMessagePayload of(DeliveryCustomFieldChangedMessagePayload template)

factory method to create a shallow copy DeliveryCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryCustomFieldChangedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static DeliveryCustomFieldChangedMessagePayload deepCopy(@Nullable
 DeliveryCustomFieldChangedMessagePayload template)

factory method to create a deep copy of DeliveryCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomFieldChangedMessagePayloadBuilder builder()

builder factory method for DeliveryCustomFieldChangedMessagePayload

Returns:

builder

builder

static DeliveryCustomFieldChangedMessagePayloadBuilder builder(DeliveryCustomFieldChangedMessagePayload template)

create builder for DeliveryCustomFieldChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomFieldChangedMessagePayload

default <T> T withDeliveryCustomFieldChangedMessagePayload(Function<DeliveryCustomFieldChangedMessagePayload,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<DeliveryCustomFieldChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference