Package com.commercetools.api.models.message

Interface PaymentTransactionStateChangedMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

PaymentTransactionStateChangedMessagePayloadImpl

public interface PaymentTransactionStateChangedMessagePayload
extends MessagePayload

Generated after a successful Change Transaction State update action.

Example to create an instance using the builder pattern

     PaymentTransactionStateChangedMessagePayload paymentTransactionStateChangedMessagePayload = PaymentTransactionStateChangedMessagePayload.builder()
             .transactionId("{transactionId}")
             .state(TransactionState.INITIAL)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAYMENT_TRANSACTION_STATE_CHANGED	discriminator value for PaymentTransactionStateChangedMessagePayload

Method Summary

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

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Field Details

PAYMENT_TRANSACTION_STATE_CHANGED

static final String PAYMENT_TRANSACTION_STATE_CHANGED

discriminator value for PaymentTransactionStateChangedMessagePayload

See Also:

• Constant Field Values

Method Details

getTransactionId

@NotNull
@NotNull String getTransactionId()

Unique identifier for the Transaction for which the Transaction State changed.

Returns:

transactionId

getState

@NotNull
@NotNull TransactionState getState()

Transaction State after the Change Transaction State update action.

Returns:

state

setTransactionId

void setTransactionId(String transactionId)

Unique identifier for the Transaction for which the Transaction State changed.

Parameters:

transactionId - value to be set

setState

void setState(TransactionState state)

Transaction State after the Change Transaction State update action.

Parameters:

state - value to be set

of

static PaymentTransactionStateChangedMessagePayload of()

factory method

Returns:

instance of PaymentTransactionStateChangedMessagePayload

of

static PaymentTransactionStateChangedMessagePayload of(PaymentTransactionStateChangedMessagePayload template)

factory method to create a shallow copy PaymentTransactionStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PaymentTransactionStateChangedMessagePayload deepCopy(@Nullable
 PaymentTransactionStateChangedMessagePayload template)

factory method to create a deep copy of PaymentTransactionStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentTransactionStateChangedMessagePayloadBuilder builder()

builder factory method for PaymentTransactionStateChangedMessagePayload

Returns:

builder

builder

static PaymentTransactionStateChangedMessagePayloadBuilder builder(PaymentTransactionStateChangedMessagePayload template)

create builder for PaymentTransactionStateChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentTransactionStateChangedMessagePayload

default <T> T withPaymentTransactionStateChangedMessagePayload(Function<PaymentTransactionStateChangedMessagePayload,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<PaymentTransactionStateChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference