Package com.commercetools.history.models.change

Interface ChangePaymentStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangePaymentStateChangeImpl

public interface ChangePaymentStateChange
extends Change

Change triggered by the following update actions:

• Change PaymentState on Orders.
• Change PaymentState on Staged Orders.

Example to create an instance using the builder pattern

     ChangePaymentStateChange changePaymentStateChange = ChangePaymentStateChange.builder()
             .change("{change}")
             .previousValue(PaymentState.BALANCE_DUE)
             .nextValue(PaymentState.BALANCE_DUE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_PAYMENT_STATE_CHANGE	discriminator value for ChangePaymentStateChange

Method Summary

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

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

withChange

Field Details

CHANGE_PAYMENT_STATE_CHANGE

static final String CHANGE_PAYMENT_STATE_CHANGE

discriminator value for ChangePaymentStateChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(PaymentState nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangePaymentStateChange of()

factory method

Returns:

instance of ChangePaymentStateChange

of

static ChangePaymentStateChange of(ChangePaymentStateChange template)

factory method to create a shallow copy ChangePaymentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangePaymentStateChange deepCopy(@Nullable
 ChangePaymentStateChange template)

factory method to create a deep copy of ChangePaymentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangePaymentStateChangeBuilder builder()

builder factory method for ChangePaymentStateChange

Returns:

builder

builder

static ChangePaymentStateChangeBuilder builder(ChangePaymentStateChange template)

create builder for ChangePaymentStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangePaymentStateChange

default <T> T withChangePaymentStateChange(Function<ChangePaymentStateChange,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<ChangePaymentStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference