Package com.commercetools.history.models.change

Interface ChangeAmountAuthorizedChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeAmountAuthorizedChangeImpl

public interface ChangeAmountAuthorizedChange
extends Change

Change triggered automatically due to a user-initiated change.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_AMOUNT_AUTHORIZED_CHANGE	discriminator value for ChangeAmountAuthorizedChange

Method Summary

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

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

withChange

Field Details

CHANGE_AMOUNT_AUTHORIZED_CHANGE

static final String CHANGE_AMOUNT_AUTHORIZED_CHANGE

discriminator value for ChangeAmountAuthorizedChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(Money nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangeAmountAuthorizedChange of()

factory method

Returns:

instance of ChangeAmountAuthorizedChange

of

static ChangeAmountAuthorizedChange of(ChangeAmountAuthorizedChange template)

factory method to create a shallow copy ChangeAmountAuthorizedChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeAmountAuthorizedChange deepCopy(@Nullable
 ChangeAmountAuthorizedChange template)

factory method to create a deep copy of ChangeAmountAuthorizedChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeAmountAuthorizedChangeBuilder builder()

builder factory method for ChangeAmountAuthorizedChange

Returns:

builder

builder

static ChangeAmountAuthorizedChangeBuilder builder(ChangeAmountAuthorizedChange template)

create builder for ChangeAmountAuthorizedChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeAmountAuthorizedChange

default <T> T withChangeAmountAuthorizedChange(Function<ChangeAmountAuthorizedChange,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<ChangeAmountAuthorizedChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference