Package com.commercetools.history.models.change

Interface ChangeStateTypeChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeStateTypeChangeImpl

public interface ChangeStateTypeChange
extends Change

Change triggered by the Change State Type update action.

Example to create an instance using the builder pattern

     ChangeStateTypeChange changeStateTypeChange = ChangeStateTypeChange.builder()
             .change("{change}")
             .previousValue(StateType.ORDER_STATE)
             .nextValue(StateType.ORDER_STATE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_STATE_TYPE_CHANGE	discriminator value for ChangeStateTypeChange

Method Summary

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

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

withChange

Field Details

CHANGE_STATE_TYPE_CHANGE

static final String CHANGE_STATE_TYPE_CHANGE

discriminator value for ChangeStateTypeChange

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 StateType getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(StateType nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangeStateTypeChange of()

factory method

Returns:

instance of ChangeStateTypeChange

of

static ChangeStateTypeChange of(ChangeStateTypeChange template)

factory method to create a shallow copy ChangeStateTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeStateTypeChange deepCopy(@Nullable
 ChangeStateTypeChange template)

factory method to create a deep copy of ChangeStateTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeStateTypeChangeBuilder builder()

builder factory method for ChangeStateTypeChange

Returns:

builder

builder

static ChangeStateTypeChangeBuilder builder(ChangeStateTypeChange template)

create builder for ChangeStateTypeChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeStateTypeChange

default <T> T withChangeStateTypeChange(Function<ChangeStateTypeChange,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<ChangeStateTypeChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference