Package com.commercetools.api.models.payment

Interface PaymentChangeTransactionStateAction

All Superinterfaces:

PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

public interface PaymentChangeTransactionStateAction
extends PaymentUpdateAction

Changing the TransactionState generates the PaymentTransactionStateChanged Message.

Example to create an instance using the builder pattern

     PaymentChangeTransactionStateAction paymentChangeTransactionStateAction = PaymentChangeTransactionStateAction.builder()
             .transactionId("{transactionId}")
             .state(TransactionState.INITIAL)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_TRANSACTION_STATE	discriminator value for PaymentChangeTransactionStateAction

Method Summary

Modifier and Type	Method	Description
static PaymentChangeTransactionStateActionBuilder	builder()	builder factory method for PaymentChangeTransactionStateAction
static PaymentChangeTransactionStateActionBuilder	builder(PaymentChangeTransactionStateAction template)	create builder for PaymentChangeTransactionStateAction instance
PaymentChangeTransactionStateAction	copyDeep()
static PaymentChangeTransactionStateAction	deepCopy(PaymentChangeTransactionStateAction template)	factory method to create a deep copy of PaymentChangeTransactionStateAction
@NotNull TransactionState	getState()	New TransactionState.
@NotNull String	getTransactionId()	Unique identifier of the Transaction.
static PaymentChangeTransactionStateAction	of()	factory method
static PaymentChangeTransactionStateAction	of(PaymentChangeTransactionStateAction template)	factory method to create a shallow copy PaymentChangeTransactionStateAction
void	setState(TransactionState state)	New TransactionState.
void	setTransactionId(String transactionId)	Unique identifier of the Transaction.
static com.fasterxml.jackson.core.type.TypeReference<PaymentChangeTransactionStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentChangeTransactionStateAction(Function<PaymentChangeTransactionStateAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.payment.PaymentUpdateAction

getAction, withPaymentUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

CHANGE_TRANSACTION_STATE

static final String CHANGE_TRANSACTION_STATE

discriminator value for PaymentChangeTransactionStateAction

See Also:

• Constant Field Values

Method Details

getTransactionId

@NotNull
@NotNull String getTransactionId()

Unique identifier of the Transaction.

Returns:

transactionId

getState

@NotNull
@NotNull TransactionState getState()

New TransactionState.

Returns:

state

setTransactionId

void setTransactionId(String transactionId)

Unique identifier of the Transaction.

Parameters:

transactionId - value to be set

setState

void setState(TransactionState state)

New TransactionState.

Parameters:

state - value to be set

of

static PaymentChangeTransactionStateAction of()

factory method

Returns:

instance of PaymentChangeTransactionStateAction

of

static PaymentChangeTransactionStateAction of(PaymentChangeTransactionStateAction template)

factory method to create a shallow copy PaymentChangeTransactionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentChangeTransactionStateAction copyDeep()

Specified by:

copyDeep in interface PaymentUpdateAction

deepCopy

@Nullable
static PaymentChangeTransactionStateAction deepCopy(@Nullable
 PaymentChangeTransactionStateAction template)

factory method to create a deep copy of PaymentChangeTransactionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentChangeTransactionStateActionBuilder builder()

builder factory method for PaymentChangeTransactionStateAction

Returns:

builder

builder

static PaymentChangeTransactionStateActionBuilder builder(PaymentChangeTransactionStateAction template)

create builder for PaymentChangeTransactionStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentChangeTransactionStateAction

default <T> T withPaymentChangeTransactionStateAction(Function<PaymentChangeTransactionStateAction,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<PaymentChangeTransactionStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference