Package com.commercetools.history.models.change

Interface ChangeLocalizedNameChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeLocalizedNameChangeImpl

public interface ChangeLocalizedNameChange
extends Change

Change triggered by the following update actions:

• Change Name on Cart Discounts.
• Change Name on Categories.
• Change Name on Channels.
• Change Name on Customer Groups.
• Change Name on Products.
• Change Name on Product Discounts.
• Change Name on Product Selections.
• Change Name on Product Types.
• Change Name on Shopping Lists.
• Change Name on Tax Categories.
• Change Name on Types.
• Change Name on Zones.

Example to create an instance using the builder pattern

     ChangeLocalizedNameChange changeLocalizedNameChange = ChangeLocalizedNameChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_LOCALIZED_NAME_CHANGE	discriminator value for ChangeLocalizedNameChange

Method Summary

Modifier and Type	Method	Description
static ChangeLocalizedNameChangeBuilder	builder()	builder factory method for ChangeLocalizedNameChange
static ChangeLocalizedNameChangeBuilder	builder(ChangeLocalizedNameChange template)	create builder for ChangeLocalizedNameChange instance
static ChangeLocalizedNameChange	deepCopy(ChangeLocalizedNameChange template)	factory method to create a deep copy of ChangeLocalizedNameChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@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.
static ChangeLocalizedNameChange	of()	factory method
static ChangeLocalizedNameChange	of(ChangeLocalizedNameChange template)	factory method to create a shallow copy ChangeLocalizedNameChange
void	setChange(String change)	set change
void	setNextValue(LocalizedString nextValue)	Value after the change.
void	setPreviousValue(LocalizedString previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<ChangeLocalizedNameChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeLocalizedNameChange(Function<ChangeLocalizedNameChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_LOCALIZED_NAME_CHANGE

static final String CHANGE_LOCALIZED_NAME_CHANGE

discriminator value for ChangeLocalizedNameChange

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

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

of

static ChangeLocalizedNameChange of()

factory method

Returns:

instance of ChangeLocalizedNameChange

of

static ChangeLocalizedNameChange of(ChangeLocalizedNameChange template)

factory method to create a shallow copy ChangeLocalizedNameChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeLocalizedNameChange deepCopy(@Nullable
 ChangeLocalizedNameChange template)

factory method to create a deep copy of ChangeLocalizedNameChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeLocalizedNameChangeBuilder builder()

builder factory method for ChangeLocalizedNameChange

Returns:

builder

builder

static ChangeLocalizedNameChangeBuilder builder(ChangeLocalizedNameChange template)

create builder for ChangeLocalizedNameChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeLocalizedNameChange

default <T> T withChangeLocalizedNameChange(Function<ChangeLocalizedNameChange,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<ChangeLocalizedNameChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference