Package com.commercetools.history.models.change

Interface ChangeDescriptionChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeDescriptionChangeImpl

public interface ChangeDescriptionChange
extends Change

Change triggered by the following update actions:

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

Example to create an instance using the builder pattern

     ChangeDescriptionChange changeDescriptionChange = ChangeDescriptionChange.builder()
             .change("{change}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_DESCRIPTION_CHANGE	discriminator value for ChangeDescriptionChange

Method Summary

Modifier and Type	Method	Description
static ChangeDescriptionChangeBuilder	builder()	builder factory method for ChangeDescriptionChange
static ChangeDescriptionChangeBuilder	builder(ChangeDescriptionChange template)	create builder for ChangeDescriptionChange instance
static ChangeDescriptionChange	deepCopy(ChangeDescriptionChange template)	factory method to create a deep copy of ChangeDescriptionChange
@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.
static ChangeDescriptionChange	of()	factory method
static ChangeDescriptionChange	of(ChangeDescriptionChange template)	factory method to create a shallow copy ChangeDescriptionChange
void	setChange(String change)	set change
void	setNextValue(String nextValue)	Value after the change.
void	setPreviousValue(String previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<ChangeDescriptionChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeDescriptionChange(Function<ChangeDescriptionChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_DESCRIPTION_CHANGE

static final String CHANGE_DESCRIPTION_CHANGE

discriminator value for ChangeDescriptionChange

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

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

of

static ChangeDescriptionChange of()

factory method

Returns:

instance of ChangeDescriptionChange

of

static ChangeDescriptionChange of(ChangeDescriptionChange template)

factory method to create a shallow copy ChangeDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeDescriptionChange deepCopy(@Nullable
 ChangeDescriptionChange template)

factory method to create a deep copy of ChangeDescriptionChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeDescriptionChangeBuilder builder()

builder factory method for ChangeDescriptionChange

Returns:

builder

builder

static ChangeDescriptionChangeBuilder builder(ChangeDescriptionChange template)

create builder for ChangeDescriptionChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeDescriptionChange

default <T> T withChangeDescriptionChange(Function<ChangeDescriptionChange,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<ChangeDescriptionChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference