Package com.commercetools.history.models.change

Interface SetLocalizedDescriptionChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetLocalizedDescriptionChangeImpl

public interface SetLocalizedDescriptionChange
extends Change

Change triggered by the following update actions:

• Set Description on Cart Discounts.
• Set Description on Categories.
• Set Description on Discount Codes.
• Set Description on Products.
• Set Description on Product Discounts.
• Set Description on Shopping Lists.
• Set Description on States.
• Set Description on Tax Categories.
• Set Description on Types.
• Set Description on Zones.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LOCALIZED_DESCRIPTION_CHANGE	discriminator value for SetLocalizedDescriptionChange

Method Summary

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

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

withChange

Field Details

SET_LOCALIZED_DESCRIPTION_CHANGE

static final String SET_LOCALIZED_DESCRIPTION_CHANGE

discriminator value for SetLocalizedDescriptionChange

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

factory method

Returns:

instance of SetLocalizedDescriptionChange

of

static SetLocalizedDescriptionChange of(SetLocalizedDescriptionChange template)

factory method to create a shallow copy SetLocalizedDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetLocalizedDescriptionChange deepCopy(@Nullable
 SetLocalizedDescriptionChange template)

factory method to create a deep copy of SetLocalizedDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetLocalizedDescriptionChangeBuilder builder()

builder factory method for SetLocalizedDescriptionChange

Returns:

builder

builder

static SetLocalizedDescriptionChangeBuilder builder(SetLocalizedDescriptionChange template)

create builder for SetLocalizedDescriptionChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetLocalizedDescriptionChange

default <T> T withSetLocalizedDescriptionChange(Function<SetLocalizedDescriptionChange,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<SetLocalizedDescriptionChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference