Package com.commercetools.api.models.message

Interface PaymentStatusStateTransitionMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface PaymentStatusStateTransitionMessagePayload
extends MessagePayload

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     PaymentStatusStateTransitionMessagePayload paymentStatusStateTransitionMessagePayload = PaymentStatusStateTransitionMessagePayload.builder()
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAYMENT_STATUS_STATE_TRANSITION	discriminator value for PaymentStatusStateTransitionMessagePayload

Method Summary

Modifier and Type	Method	Description
static PaymentStatusStateTransitionMessagePayloadBuilder	builder()	builder factory method for PaymentStatusStateTransitionMessagePayload
static PaymentStatusStateTransitionMessagePayloadBuilder	builder(PaymentStatusStateTransitionMessagePayload template)	create builder for PaymentStatusStateTransitionMessagePayload instance
PaymentStatusStateTransitionMessagePayload	copyDeep()
static PaymentStatusStateTransitionMessagePayload	deepCopy(PaymentStatusStateTransitionMessagePayload template)	factory method to create a deep copy of PaymentStatusStateTransitionMessagePayload
@NotNull Boolean	getForce()	Whether State transition validations were turned off during the Change Transaction State update action.
@NotNull @Valid StateReference	getState()	State of the Payment after the Transition State update action.
static PaymentStatusStateTransitionMessagePayload	of()	factory method
static PaymentStatusStateTransitionMessagePayload	of(PaymentStatusStateTransitionMessagePayload template)	factory method to create a shallow copy PaymentStatusStateTransitionMessagePayload
void	setForce(Boolean force)	Whether State transition validations were turned off during the Change Transaction State update action.
void	setState(StateReference state)	State of the Payment after the Transition State update action.
static com.fasterxml.jackson.core.type.TypeReference<PaymentStatusStateTransitionMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentStatusStateTransitionMessagePayload(Function<PaymentStatusStateTransitionMessagePayload,T> helper)	accessor map function

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

getType, withMessagePayload

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

as

Field Details

PAYMENT_STATUS_STATE_TRANSITION

static final String PAYMENT_STATUS_STATE_TRANSITION

discriminator value for PaymentStatusStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getState

@NotNull
@Valid
@NotNull @Valid StateReference getState()

State of the Payment after the Transition State update action.

Returns:

state

getForce

@NotNull
@NotNull Boolean getForce()

Whether State transition validations were turned off during the Change Transaction State update action.

Returns:

force

setState

void setState(StateReference state)

State of the Payment after the Transition State update action.

Parameters:

state - value to be set

setForce

void setForce(Boolean force)

Whether State transition validations were turned off during the Change Transaction State update action.

Parameters:

force - value to be set

of

static PaymentStatusStateTransitionMessagePayload of()

factory method

Returns:

instance of PaymentStatusStateTransitionMessagePayload

of

static PaymentStatusStateTransitionMessagePayload of(PaymentStatusStateTransitionMessagePayload template)

factory method to create a shallow copy PaymentStatusStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentStatusStateTransitionMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static PaymentStatusStateTransitionMessagePayload deepCopy(@Nullable
 PaymentStatusStateTransitionMessagePayload template)

factory method to create a deep copy of PaymentStatusStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentStatusStateTransitionMessagePayloadBuilder builder()

builder factory method for PaymentStatusStateTransitionMessagePayload

Returns:

builder

builder

static PaymentStatusStateTransitionMessagePayloadBuilder builder(PaymentStatusStateTransitionMessagePayload template)

create builder for PaymentStatusStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentStatusStateTransitionMessagePayload

default <T> T withPaymentStatusStateTransitionMessagePayload(Function<PaymentStatusStateTransitionMessagePayload,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<PaymentStatusStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference