Package com.commercetools.api.models.message

Interface RecurringOrderCustomFieldChangedMessage

All Superinterfaces:

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

All Known Implementing Classes:

RecurringOrderCustomFieldChangedMessageImpl

public interface RecurringOrderCustomFieldChangedMessage
extends Message

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

Example to create an instance using the builder pattern

     RecurringOrderCustomFieldChangedMessage recurringOrderCustomFieldChangedMessage = RecurringOrderCustomFieldChangedMessage.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	RECURRING_ORDER_CUSTOM_FIELD_CHANGED	discriminator value for RecurringOrderCustomFieldChangedMessage

Method Summary

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

Field Details

RECURRING_ORDER_CUSTOM_FIELD_CHANGED

static final String RECURRING_ORDER_CUSTOM_FIELD_CHANGED

discriminator value for RecurringOrderCustomFieldChangedMessage

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

Returns:

previousValue

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

Parameters:

previousValue - value to be set

of

static RecurringOrderCustomFieldChangedMessage of()

factory method

Returns:

instance of RecurringOrderCustomFieldChangedMessage

of

static RecurringOrderCustomFieldChangedMessage of(RecurringOrderCustomFieldChangedMessage template)

factory method to create a shallow copy RecurringOrderCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderCustomFieldChangedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static RecurringOrderCustomFieldChangedMessage deepCopy(@Nullable
 RecurringOrderCustomFieldChangedMessage template)

factory method to create a deep copy of RecurringOrderCustomFieldChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderCustomFieldChangedMessageBuilder builder()

builder factory method for RecurringOrderCustomFieldChangedMessage

Returns:

builder

builder

static RecurringOrderCustomFieldChangedMessageBuilder builder(RecurringOrderCustomFieldChangedMessage template)

create builder for RecurringOrderCustomFieldChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderCustomFieldChangedMessage

default <T> T withRecurringOrderCustomFieldChangedMessage(Function<RecurringOrderCustomFieldChangedMessage,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<RecurringOrderCustomFieldChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference