Package com.commercetools.api.models.message

Interface RecurringOrderCustomFieldChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface RecurringOrderCustomFieldChangedMessagePayload
extends MessagePayload

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

Example to create an instance using the builder pattern

     RecurringOrderCustomFieldChangedMessagePayload recurringOrderCustomFieldChangedMessagePayload = RecurringOrderCustomFieldChangedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECURRING_ORDER_CUSTOM_FIELD_CHANGED	discriminator value for RecurringOrderCustomFieldChangedMessagePayload

Method Summary

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

Field Details

RECURRING_ORDER_CUSTOM_FIELD_CHANGED

static final String RECURRING_ORDER_CUSTOM_FIELD_CHANGED

discriminator value for RecurringOrderCustomFieldChangedMessagePayload

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

factory method

Returns:

instance of RecurringOrderCustomFieldChangedMessagePayload

of

static RecurringOrderCustomFieldChangedMessagePayload of(RecurringOrderCustomFieldChangedMessagePayload template)

factory method to create a shallow copy RecurringOrderCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

RecurringOrderCustomFieldChangedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static RecurringOrderCustomFieldChangedMessagePayload deepCopy(@Nullable
 RecurringOrderCustomFieldChangedMessagePayload template)

factory method to create a deep copy of RecurringOrderCustomFieldChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RecurringOrderCustomFieldChangedMessagePayloadBuilder builder()

builder factory method for RecurringOrderCustomFieldChangedMessagePayload

Returns:

builder

builder

static RecurringOrderCustomFieldChangedMessagePayloadBuilder builder(RecurringOrderCustomFieldChangedMessagePayload template)

create builder for RecurringOrderCustomFieldChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRecurringOrderCustomFieldChangedMessagePayload

default <T> T withRecurringOrderCustomFieldChangedMessagePayload(Function<RecurringOrderCustomFieldChangedMessagePayload,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<RecurringOrderCustomFieldChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference