Package com.commercetools.api.models.message

Interface DeliveryCustomFieldChangedMessage

All Superinterfaces:

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

public interface DeliveryCustomFieldChangedMessage
extends OrderMessage

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

     DeliveryCustomFieldChangedMessage deliveryCustomFieldChangedMessage = DeliveryCustomFieldChangedMessage.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}")
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DeliveryCustomFieldChangedMessageBuilder	builder()	builder factory method for DeliveryCustomFieldChangedMessage
static DeliveryCustomFieldChangedMessageBuilder	builder(DeliveryCustomFieldChangedMessage template)	create builder for DeliveryCustomFieldChangedMessage instance
DeliveryCustomFieldChangedMessage	copyDeep()
static DeliveryCustomFieldChangedMessage	deepCopy(DeliveryCustomFieldChangedMessage template)	factory method to create a deep copy of DeliveryCustomFieldChangedMessage
@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 DeliveryCustomFieldChangedMessage	of()	factory method
static DeliveryCustomFieldChangedMessage	of(DeliveryCustomFieldChangedMessage template)	factory method to create a shallow copy DeliveryCustomFieldChangedMessage
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<DeliveryCustomFieldChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryCustomFieldChangedMessage(Function<DeliveryCustomFieldChangedMessage,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

DELIVERY_CUSTOM_FIELD_CHANGED

static final String DELIVERY_CUSTOM_FIELD_CHANGED

discriminator value for DeliveryCustomFieldChangedMessage

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

factory method

Returns:

instance of DeliveryCustomFieldChangedMessage

of

static DeliveryCustomFieldChangedMessage of(DeliveryCustomFieldChangedMessage template)

factory method to create a shallow copy DeliveryCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryCustomFieldChangedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static DeliveryCustomFieldChangedMessage deepCopy(@Nullable
 DeliveryCustomFieldChangedMessage template)

factory method to create a deep copy of DeliveryCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryCustomFieldChangedMessageBuilder builder()

builder factory method for DeliveryCustomFieldChangedMessage

Returns:

builder

builder

static DeliveryCustomFieldChangedMessageBuilder builder(DeliveryCustomFieldChangedMessage template)

create builder for DeliveryCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryCustomFieldChangedMessage

default <T> T withDeliveryCustomFieldChangedMessage(Function<DeliveryCustomFieldChangedMessage,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<DeliveryCustomFieldChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference