Package com.commercetools.history.models.change

Interface SetReturnPaymentStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetReturnPaymentStateChangeImpl

public interface SetReturnPaymentStateChange
extends Change

Change triggered by the following update actions:

• Set PaymentShipmentState on Orders.
• Set PaymentShipmentState on Staged Orders.

Example to create an instance using the builder pattern

     SetReturnPaymentStateChange setReturnPaymentStateChange = SetReturnPaymentStateChange.builder()
             .change("{change}")
             .previousValue(ReturnPaymentState.NON_REFUNDABLE)
             .nextValue(ReturnPaymentState.NON_REFUNDABLE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_RETURN_PAYMENT_STATE_CHANGE	discriminator value for SetReturnPaymentStateChange

Method Summary

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

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

withChange

Field Details

SET_RETURN_PAYMENT_STATE_CHANGE

static final String SET_RETURN_PAYMENT_STATE_CHANGE

discriminator value for SetReturnPaymentStateChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ReturnPaymentState nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetReturnPaymentStateChange of()

factory method

Returns:

instance of SetReturnPaymentStateChange

of

static SetReturnPaymentStateChange of(SetReturnPaymentStateChange template)

factory method to create a shallow copy SetReturnPaymentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetReturnPaymentStateChange deepCopy(@Nullable
 SetReturnPaymentStateChange template)

factory method to create a deep copy of SetReturnPaymentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetReturnPaymentStateChangeBuilder builder()

builder factory method for SetReturnPaymentStateChange

Returns:

builder

builder

static SetReturnPaymentStateChangeBuilder builder(SetReturnPaymentStateChange template)

create builder for SetReturnPaymentStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetReturnPaymentStateChange

default <T> T withSetReturnPaymentStateChange(Function<SetReturnPaymentStateChange,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<SetReturnPaymentStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference