Package com.commercetools.history.models.change

Interface ChangePlainEnumValueLabelChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangePlainEnumValueLabelChangeImpl

public interface ChangePlainEnumValueLabelChange
extends Change

Change triggered by the Change the label of an EnumValue update action.

Example to create an instance using the builder pattern

     ChangePlainEnumValueLabelChange changePlainEnumValueLabelChange = ChangePlainEnumValueLabelChange.builder()
             .change("{change}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .attributeName("{attributeName}")
             .valueKey("{valueKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_PLAIN_ENUM_VALUE_LABEL_CHANGE	discriminator value for ChangePlainEnumValueLabelChange

Method Summary

Modifier and Type	Method	Description
static ChangePlainEnumValueLabelChangeBuilder	builder()	builder factory method for ChangePlainEnumValueLabelChange
static ChangePlainEnumValueLabelChangeBuilder	builder(ChangePlainEnumValueLabelChange template)	create builder for ChangePlainEnumValueLabelChange instance
static ChangePlainEnumValueLabelChange	deepCopy(ChangePlainEnumValueLabelChange template)	factory method to create a deep copy of ChangePlainEnumValueLabelChange
@NotNull String	getAttributeName()	Name of the updated AttributeDefinition.
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@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 ChangePlainEnumValueLabelChange	of()	factory method
static ChangePlainEnumValueLabelChange	of(ChangePlainEnumValueLabelChange template)	factory method to create a shallow copy ChangePlainEnumValueLabelChange
void	setAttributeName(String attributeName)	Name of the updated AttributeDefinition.
void	setChange(String change)	set change
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<ChangePlainEnumValueLabelChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangePlainEnumValueLabelChange(Function<ChangePlainEnumValueLabelChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_PLAIN_ENUM_VALUE_LABEL_CHANGE

static final String CHANGE_PLAIN_ENUM_VALUE_LABEL_CHANGE

discriminator value for ChangePlainEnumValueLabelChange

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

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the updated AttributeDefinition.

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(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

setAttributeName

void setAttributeName(String attributeName)

Name of the updated AttributeDefinition.

Parameters:

attributeName - value to be set

setValueKey

void setValueKey(String valueKey)

Key of the updated values.

Parameters:

valueKey - value to be set

of

static ChangePlainEnumValueLabelChange of()

factory method

Returns:

instance of ChangePlainEnumValueLabelChange

of

static ChangePlainEnumValueLabelChange of(ChangePlainEnumValueLabelChange template)

factory method to create a shallow copy ChangePlainEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangePlainEnumValueLabelChange deepCopy(@Nullable
 ChangePlainEnumValueLabelChange template)

factory method to create a deep copy of ChangePlainEnumValueLabelChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangePlainEnumValueLabelChangeBuilder builder()

builder factory method for ChangePlainEnumValueLabelChange

Returns:

builder

builder

static ChangePlainEnumValueLabelChangeBuilder builder(ChangePlainEnumValueLabelChange template)

create builder for ChangePlainEnumValueLabelChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangePlainEnumValueLabelChange

default <T> T withChangePlainEnumValueLabelChange(Function<ChangePlainEnumValueLabelChange,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<ChangePlainEnumValueLabelChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference