Package com.commercetools.history.models.change

Interface ChangeOrderStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeOrderStateChangeImpl

public interface ChangeOrderStateChange
extends Change

Change triggered by the following update actions:

• Change OrderState on Orders.
• Change OrderState on Staged Orders.

Example to create an instance using the builder pattern

     ChangeOrderStateChange changeOrderStateChange = ChangeOrderStateChange.builder()
             .change("{change}")
             .previousValue(OrderState.OPEN)
             .nextValue(OrderState.OPEN)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ORDER_STATE_CHANGE	discriminator value for ChangeOrderStateChange

Method Summary

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

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

withChange

Field Details

CHANGE_ORDER_STATE_CHANGE

static final String CHANGE_ORDER_STATE_CHANGE

discriminator value for ChangeOrderStateChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(OrderState nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangeOrderStateChange of()

factory method

Returns:

instance of ChangeOrderStateChange

of

static ChangeOrderStateChange of(ChangeOrderStateChange template)

factory method to create a shallow copy ChangeOrderStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeOrderStateChange deepCopy(@Nullable
 ChangeOrderStateChange template)

factory method to create a deep copy of ChangeOrderStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeOrderStateChangeBuilder builder()

builder factory method for ChangeOrderStateChange

Returns:

builder

builder

static ChangeOrderStateChangeBuilder builder(ChangeOrderStateChange template)

create builder for ChangeOrderStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeOrderStateChange

default <T> T withChangeOrderStateChange(Function<ChangeOrderStateChange,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<ChangeOrderStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference