Package com.commercetools.api.models.message

Interface PaymentStatusStateTransitionMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface PaymentStatusStateTransitionMessage
extends Message

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     PaymentStatusStateTransitionMessage paymentStatusStateTransitionMessage = PaymentStatusStateTransitionMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static PaymentStatusStateTransitionMessageBuilder	builder()	builder factory method for PaymentStatusStateTransitionMessage
static PaymentStatusStateTransitionMessageBuilder	builder(PaymentStatusStateTransitionMessage template)	create builder for PaymentStatusStateTransitionMessage instance
PaymentStatusStateTransitionMessage	copyDeep()
static PaymentStatusStateTransitionMessage	deepCopy(PaymentStatusStateTransitionMessage template)	factory method to create a deep copy of PaymentStatusStateTransitionMessage
@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 PaymentStatusStateTransitionMessage	of()	factory method
static PaymentStatusStateTransitionMessage	of(PaymentStatusStateTransitionMessage template)	factory method to create a shallow copy PaymentStatusStateTransitionMessage
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<PaymentStatusStateTransitionMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentStatusStateTransitionMessage(Function<PaymentStatusStateTransitionMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

PAYMENT_STATUS_STATE_TRANSITION

static final String PAYMENT_STATUS_STATE_TRANSITION

discriminator value for PaymentStatusStateTransitionMessage

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 PaymentStatusStateTransitionMessage of()

factory method

Returns:

instance of PaymentStatusStateTransitionMessage

of

static PaymentStatusStateTransitionMessage of(PaymentStatusStateTransitionMessage template)

factory method to create a shallow copy PaymentStatusStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentStatusStateTransitionMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static PaymentStatusStateTransitionMessage deepCopy(@Nullable
 PaymentStatusStateTransitionMessage template)

factory method to create a deep copy of PaymentStatusStateTransitionMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentStatusStateTransitionMessageBuilder builder()

builder factory method for PaymentStatusStateTransitionMessage

Returns:

builder

builder

static PaymentStatusStateTransitionMessageBuilder builder(PaymentStatusStateTransitionMessage template)

create builder for PaymentStatusStateTransitionMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentStatusStateTransitionMessage

default <T> T withPaymentStatusStateTransitionMessage(Function<PaymentStatusStateTransitionMessage,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<PaymentStatusStateTransitionMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference