Package com.commercetools.history.models.change

Interface ChangeTransactionStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeTransactionStateChangeImpl

public interface ChangeTransactionStateChange
extends Change

Change triggered by the Change TransactionState update action.

Example to create an instance using the builder pattern

     ChangeTransactionStateChange changeTransactionStateChange = ChangeTransactionStateChange.builder()
             .change("{change}")
             .previousValue(TransactionState.INITIAL)
             .nextValue(TransactionState.INITIAL)
             .transaction(transactionBuilder -> transactionBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_TRANSACTION_STATE_CHANGE	discriminator value for ChangeTransactionStateChange

Method Summary

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

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

withChange

Field Details

CHANGE_TRANSACTION_STATE_CHANGE

static final String CHANGE_TRANSACTION_STATE_CHANGE

discriminator value for ChangeTransactionStateChange

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
@NotNull TransactionState getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull TransactionState getNextValue()

Value after the change.

Returns:

nextValue

getTransaction

@NotNull
@Valid
@NotNull @Valid TransactionChangeValue getTransaction()

Holds information about the updated Transaction.

Returns:

transaction

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(TransactionState previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(TransactionState nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setTransaction

void setTransaction(TransactionChangeValue transaction)

Holds information about the updated Transaction.

Parameters:

transaction - value to be set

of

static ChangeTransactionStateChange of()

factory method

Returns:

instance of ChangeTransactionStateChange

of

static ChangeTransactionStateChange of(ChangeTransactionStateChange template)

factory method to create a shallow copy ChangeTransactionStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeTransactionStateChange deepCopy(@Nullable
 ChangeTransactionStateChange template)

factory method to create a deep copy of ChangeTransactionStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeTransactionStateChangeBuilder builder()

builder factory method for ChangeTransactionStateChange

Returns:

builder

builder

static ChangeTransactionStateChangeBuilder builder(ChangeTransactionStateChange template)

create builder for ChangeTransactionStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeTransactionStateChange

default <T> T withChangeTransactionStateChange(Function<ChangeTransactionStateChange,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<ChangeTransactionStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference