Package com.commercetools.history.models.change

Interface ChangeLocalizedEnumValueLabelChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeLocalizedEnumValueLabelChangeImpl

public interface ChangeLocalizedEnumValueLabelChange
extends Change

Change triggered by the following update actions:

• Change the label of a LocalizedEnumValue on Product Types.
• Change LocalizedEnumValue Label on Types.

Example to create an instance using the builder pattern

     ChangeLocalizedEnumValueLabelChange changeLocalizedEnumValueLabelChange = ChangeLocalizedEnumValueLabelChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .fieldName("{fieldName}")
             .attributeName("{attributeName}")
             .valueKey("{valueKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_LOCALIZED_ENUM_VALUE_LABEL_CHANGE	discriminator value for ChangeLocalizedEnumValueLabelChange

Method Summary

Modifier and Type	Method	Description
static ChangeLocalizedEnumValueLabelChangeBuilder	builder()	builder factory method for ChangeLocalizedEnumValueLabelChange
static ChangeLocalizedEnumValueLabelChangeBuilder	builder(ChangeLocalizedEnumValueLabelChange template)	create builder for ChangeLocalizedEnumValueLabelChange instance
static ChangeLocalizedEnumValueLabelChange	deepCopy(ChangeLocalizedEnumValueLabelChange template)	factory method to create a deep copy of ChangeLocalizedEnumValueLabelChange
@NotNull String	getAttributeName()	Name of the updated AttributeDefinition; only present on changes to Product Types.
@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; only present on changes to Types.
@NotNull @Valid LocalizedString	getNextValue()	Value after the change.
@NotNull @Valid LocalizedString	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 ChangeLocalizedEnumValueLabelChange	of()	factory method
static ChangeLocalizedEnumValueLabelChange	of(ChangeLocalizedEnumValueLabelChange template)	factory method to create a shallow copy ChangeLocalizedEnumValueLabelChange
void	setAttributeName(String attributeName)	Name of the updated AttributeDefinition; only present on changes to Product Types.
void	setChange(String change)	set change
void	setFieldName(String fieldName)	Name of the updated FieldDefinition; only present on changes to Types.
void	setNextValue(LocalizedString nextValue)	Value after the change.
void	setPreviousValue(LocalizedString previousValue)	Value before the change.
void	setValueKey(String valueKey)	Key of the updated values.
static com.fasterxml.jackson.core.type.TypeReference<ChangeLocalizedEnumValueLabelChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeLocalizedEnumValueLabelChange(Function<ChangeLocalizedEnumValueLabelChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_LOCALIZED_ENUM_VALUE_LABEL_CHANGE

static final String CHANGE_LOCALIZED_ENUM_VALUE_LABEL_CHANGE

discriminator value for ChangeLocalizedEnumValueLabelChange

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
@Valid
@NotNull @Valid LocalizedString getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid LocalizedString getNextValue()

Value after the change.

Returns:

nextValue

getFieldName

@NotNull
@NotNull String getFieldName()

Name of the updated FieldDefinition; only present on changes to Types.

Returns:

fieldName

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the updated AttributeDefinition; only present on changes to Product Types.

Returns:

attributeName

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(LocalizedString previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(LocalizedString nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setFieldName

void setFieldName(String fieldName)

Name of the updated FieldDefinition; only present on changes to Types.

Parameters:

fieldName - value to be set

setAttributeName

void setAttributeName(String attributeName)

Name of the updated AttributeDefinition; only present on changes to Product Types.

Parameters:

attributeName - value to be set

setValueKey

void setValueKey(String valueKey)

Key of the updated values.

Parameters:

valueKey - value to be set

of

static ChangeLocalizedEnumValueLabelChange of()

factory method

Returns:

instance of ChangeLocalizedEnumValueLabelChange

of

static ChangeLocalizedEnumValueLabelChange of(ChangeLocalizedEnumValueLabelChange template)

factory method to create a shallow copy ChangeLocalizedEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeLocalizedEnumValueLabelChange deepCopy(@Nullable
 ChangeLocalizedEnumValueLabelChange template)

factory method to create a deep copy of ChangeLocalizedEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeLocalizedEnumValueLabelChangeBuilder builder()

builder factory method for ChangeLocalizedEnumValueLabelChange

Returns:

builder

builder

static ChangeLocalizedEnumValueLabelChangeBuilder builder(ChangeLocalizedEnumValueLabelChange template)

create builder for ChangeLocalizedEnumValueLabelChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeLocalizedEnumValueLabelChange

default <T> T withChangeLocalizedEnumValueLabelChange(Function<ChangeLocalizedEnumValueLabelChange,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<ChangeLocalizedEnumValueLabelChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference