Package com.commercetools.history.models.change

Interface AddLocalizedEnumValueChange

All Superinterfaces:

Change

All Known Implementing Classes:

AddLocalizedEnumValueChangeImpl

public interface AddLocalizedEnumValueChange
extends Change

Change triggered by the following update actions:

• Add LocalizableEnumValue to AttributeDefinition on Product Types.
• Add LocalizedEnumValue to FieldDefinition on Types.

Example to create an instance using the builder pattern

     AddLocalizedEnumValueChange addLocalizedEnumValueChange = AddLocalizedEnumValueChange.builder()
             .change("{change}")
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .fieldName("{fieldName}")
             .attributeName("{attributeName}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_LOCALIZED_ENUM_VALUE_CHANGE	discriminator value for AddLocalizedEnumValueChange

Method Summary

Modifier and Type	Method	Description
static AddLocalizedEnumValueChangeBuilder	builder()	builder factory method for AddLocalizedEnumValueChange
static AddLocalizedEnumValueChangeBuilder	builder(AddLocalizedEnumValueChange template)	create builder for AddLocalizedEnumValueChange instance
static AddLocalizedEnumValueChange	deepCopy(AddLocalizedEnumValueChange template)	factory method to create a deep copy of AddLocalizedEnumValueChange
@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 LocalizedEnumValue	getNextValue()	Value after the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static AddLocalizedEnumValueChange	of()	factory method
static AddLocalizedEnumValueChange	of(AddLocalizedEnumValueChange template)	factory method to create a shallow copy AddLocalizedEnumValueChange
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(LocalizedEnumValue nextValue)	Value after the change.
static com.fasterxml.jackson.core.type.TypeReference<AddLocalizedEnumValueChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAddLocalizedEnumValueChange(Function<AddLocalizedEnumValueChange,T> helper)	accessor map function

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

withChange

Field Details

ADD_LOCALIZED_ENUM_VALUE_CHANGE

static final String ADD_LOCALIZED_ENUM_VALUE_CHANGE

discriminator value for AddLocalizedEnumValueChange

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

getNextValue

@NotNull
@Valid
@NotNull @Valid LocalizedEnumValue 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

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setNextValue

void setNextValue(LocalizedEnumValue 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

of

static AddLocalizedEnumValueChange of()

factory method

Returns:

instance of AddLocalizedEnumValueChange

of

static AddLocalizedEnumValueChange of(AddLocalizedEnumValueChange template)

factory method to create a shallow copy AddLocalizedEnumValueChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AddLocalizedEnumValueChange deepCopy(@Nullable
 AddLocalizedEnumValueChange template)

factory method to create a deep copy of AddLocalizedEnumValueChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddLocalizedEnumValueChangeBuilder builder()

builder factory method for AddLocalizedEnumValueChange

Returns:

builder

builder

static AddLocalizedEnumValueChangeBuilder builder(AddLocalizedEnumValueChange template)

create builder for AddLocalizedEnumValueChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddLocalizedEnumValueChange

default <T> T withAddLocalizedEnumValueChange(Function<AddLocalizedEnumValueChange,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<AddLocalizedEnumValueChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference