Package com.commercetools.history.models.change

Interface ChangeTargetChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeTargetChangeImpl

public interface ChangeTargetChange
extends Change

Change triggered by the Change Target update action.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_TARGET_CHANGE	discriminator value for ChangeTargetChange

Method Summary

Modifier and Type	Method	Description
static ChangeTargetChangeBuilder	builder()	builder factory method for ChangeTargetChange
static ChangeTargetChangeBuilder	builder(ChangeTargetChange template)	create builder for ChangeTargetChange instance
static ChangeTargetChange	deepCopy(ChangeTargetChange template)	factory method to create a deep copy of ChangeTargetChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid ChangeTargetChangeValue	getNextValue()	Value after the change.
@NotNull @Valid ChangeTargetChangeValue	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static ChangeTargetChange	of()	factory method
static ChangeTargetChange	of(ChangeTargetChange template)	factory method to create a shallow copy ChangeTargetChange
void	setChange(String change)	set change
void	setNextValue(ChangeTargetChangeValue nextValue)	Value after the change.
void	setPreviousValue(ChangeTargetChangeValue previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<ChangeTargetChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeTargetChange(Function<ChangeTargetChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_TARGET_CHANGE

static final String CHANGE_TARGET_CHANGE

discriminator value for ChangeTargetChange

See Also:

• Constant Field Values

Method Details

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

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

getPreviousValue

@NotNull
@Valid
@NotNull @Valid ChangeTargetChangeValue getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid ChangeTargetChangeValue 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(ChangeTargetChangeValue previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ChangeTargetChangeValue nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangeTargetChange of()

factory method

Returns:

instance of ChangeTargetChange

of

static ChangeTargetChange of(ChangeTargetChange template)

factory method to create a shallow copy ChangeTargetChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeTargetChange deepCopy(@Nullable
 ChangeTargetChange template)

factory method to create a deep copy of ChangeTargetChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeTargetChangeBuilder builder()

builder factory method for ChangeTargetChange

Returns:

builder

builder

static ChangeTargetChangeBuilder builder(ChangeTargetChange template)

create builder for ChangeTargetChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeTargetChange

default <T> T withChangeTargetChange(Function<ChangeTargetChange,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<ChangeTargetChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference