Package com.commercetools.history.models.change

Interface ChangeLocalizedDescriptionChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeLocalizedDescriptionChangeImpl

public interface ChangeLocalizedDescriptionChange
extends Change

Change triggered by the following update actions:

• Change Description on Product Types.
• Change Description on Channels.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_LOCALIZED_DESCRIPTION_CHANGE	discriminator value for ChangeLocalizedDescriptionChange

Method Summary

Modifier and Type	Method	Description
static ChangeLocalizedDescriptionChangeBuilder	builder()	builder factory method for ChangeLocalizedDescriptionChange
static ChangeLocalizedDescriptionChangeBuilder	builder(ChangeLocalizedDescriptionChange template)	create builder for ChangeLocalizedDescriptionChange instance
static ChangeLocalizedDescriptionChange	deepCopy(ChangeLocalizedDescriptionChange template)	factory method to create a deep copy of ChangeLocalizedDescriptionChange
@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 ChangeLocalizedDescriptionChange	of()	factory method
static ChangeLocalizedDescriptionChange	of(ChangeLocalizedDescriptionChange template)	factory method to create a shallow copy ChangeLocalizedDescriptionChange
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<ChangeLocalizedDescriptionChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeLocalizedDescriptionChange(Function<ChangeLocalizedDescriptionChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_LOCALIZED_DESCRIPTION_CHANGE

static final String CHANGE_LOCALIZED_DESCRIPTION_CHANGE

discriminator value for ChangeLocalizedDescriptionChange

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 ChangeLocalizedDescriptionChange of()

factory method

Returns:

instance of ChangeLocalizedDescriptionChange

of

static ChangeLocalizedDescriptionChange of(ChangeLocalizedDescriptionChange template)

factory method to create a shallow copy ChangeLocalizedDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeLocalizedDescriptionChange deepCopy(@Nullable
 ChangeLocalizedDescriptionChange template)

factory method to create a deep copy of ChangeLocalizedDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeLocalizedDescriptionChangeBuilder builder()

builder factory method for ChangeLocalizedDescriptionChange

Returns:

builder

builder

static ChangeLocalizedDescriptionChangeBuilder builder(ChangeLocalizedDescriptionChange template)

create builder for ChangeLocalizedDescriptionChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeLocalizedDescriptionChange

default <T> T withChangeLocalizedDescriptionChange(Function<ChangeLocalizedDescriptionChange,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<ChangeLocalizedDescriptionChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference