Package com.commercetools.history.models.change

Interface ChangeEnumValueLabelChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeEnumValueLabelChangeImpl

public interface ChangeEnumValueLabelChange
extends Change

Change triggered by the Change EnumValue Label update action.

Example to create an instance using the builder pattern

     ChangeEnumValueLabelChange changeEnumValueLabelChange = ChangeEnumValueLabelChange.builder()
             .change("{change}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .fieldName("{fieldName}")
             .valueKey("{valueKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ENUM_VALUE_LABEL_CHANGE	discriminator value for ChangeEnumValueLabelChange

Method Summary

Modifier and Type	Method	Description
static ChangeEnumValueLabelChangeBuilder	builder()	builder factory method for ChangeEnumValueLabelChange
static ChangeEnumValueLabelChangeBuilder	builder(ChangeEnumValueLabelChange template)	create builder for ChangeEnumValueLabelChange instance
static ChangeEnumValueLabelChange	deepCopy(ChangeEnumValueLabelChange template)	factory method to create a deep copy of ChangeEnumValueLabelChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getFieldName()	Name of the updated FieldDefinition.
@NotNull String	getNextValue()	Value after the change.
@NotNull String	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
@NotNull String	getValueKey()	Key of the updated values.
static ChangeEnumValueLabelChange	of()	factory method
static ChangeEnumValueLabelChange	of(ChangeEnumValueLabelChange template)	factory method to create a shallow copy ChangeEnumValueLabelChange
void	setChange(String change)	set change
void	setFieldName(String fieldName)	Name of the updated FieldDefinition.
void	setNextValue(String nextValue)	Value after the change.
void	setPreviousValue(String previousValue)	Value before the change.
void	setValueKey(String valueKey)	Key of the updated values.
static com.fasterxml.jackson.core.type.TypeReference<ChangeEnumValueLabelChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeEnumValueLabelChange(Function<ChangeEnumValueLabelChange,T> helper)	accessor map function

Methods inherited from interface com.commercetools.history.models.change.Change

withChange

Field Details

CHANGE_ENUM_VALUE_LABEL_CHANGE

static final String CHANGE_ENUM_VALUE_LABEL_CHANGE

discriminator value for ChangeEnumValueLabelChange

See Also:

• Constant Field Values

Method Details

getType

@NotNull
@NotNull String getType()

Description copied from interface: Change

Unique discriminator value to reliably deserialize the data type.

Specified by:

getType in interface Change

Returns:

type

getChange

@NotNull
@NotNull String getChange()

Description copied from interface: Change

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

Records can be filtered by this value using the changes query parameter.

Specified by:

getChange in interface Change

Returns:

change

getPreviousValue

@NotNull
@NotNull String getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull String getNextValue()

Value after the change.

Returns:

nextValue

getFieldName

@NotNull
@NotNull String getFieldName()

Name of the updated FieldDefinition.

Returns:

fieldName

getValueKey

@NotNull
@NotNull String getValueKey()

Key of the updated values.

Returns:

valueKey

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(String previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(String nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setFieldName

void setFieldName(String fieldName)

Name of the updated FieldDefinition.

Parameters:

fieldName - value to be set

setValueKey

void setValueKey(String valueKey)

Key of the updated values.

Parameters:

valueKey - value to be set

of

static ChangeEnumValueLabelChange of()

factory method

Returns:

instance of ChangeEnumValueLabelChange

of

static ChangeEnumValueLabelChange of(ChangeEnumValueLabelChange template)

factory method to create a shallow copy ChangeEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeEnumValueLabelChange deepCopy(@Nullable
 ChangeEnumValueLabelChange template)

factory method to create a deep copy of ChangeEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeEnumValueLabelChangeBuilder builder()

builder factory method for ChangeEnumValueLabelChange

Returns:

builder

builder

static ChangeEnumValueLabelChangeBuilder builder(ChangeEnumValueLabelChange template)

create builder for ChangeEnumValueLabelChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeEnumValueLabelChange

default <T> T withChangeEnumValueLabelChange(Function<ChangeEnumValueLabelChange,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<ChangeEnumValueLabelChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference