Package com.commercetools.api.models.message

Interface QuoteStateTransitionMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface QuoteStateTransitionMessagePayload
extends MessagePayload

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     QuoteStateTransitionMessagePayload quoteStateTransitionMessagePayload = QuoteStateTransitionMessagePayload.builder()
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUOTE_STATE_TRANSITION	discriminator value for QuoteStateTransitionMessagePayload

Method Summary

Modifier and Type	Method	Description
static QuoteStateTransitionMessagePayloadBuilder	builder()	builder factory method for QuoteStateTransitionMessagePayload
static QuoteStateTransitionMessagePayloadBuilder	builder(QuoteStateTransitionMessagePayload template)	create builder for QuoteStateTransitionMessagePayload instance
QuoteStateTransitionMessagePayload	copyDeep()
static QuoteStateTransitionMessagePayload	deepCopy(QuoteStateTransitionMessagePayload template)	factory method to create a deep copy of QuoteStateTransitionMessagePayload
@NotNull Boolean	getForce()	Whether State transition validations were turned off during the Transition State update action.
@Valid StateReference	getOldState()	State of the Quote before the Transition State update action.
@NotNull @Valid StateReference	getState()	State of the Quote after the Transition State update action.
static QuoteStateTransitionMessagePayload	of()	factory method
static QuoteStateTransitionMessagePayload	of(QuoteStateTransitionMessagePayload template)	factory method to create a shallow copy QuoteStateTransitionMessagePayload
void	setForce(Boolean force)	Whether State transition validations were turned off during the Transition State update action.
void	setOldState(StateReference oldState)	State of the Quote before the Transition State update action.
void	setState(StateReference state)	State of the Quote after the Transition State update action.
static com.fasterxml.jackson.core.type.TypeReference<QuoteStateTransitionMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withQuoteStateTransitionMessagePayload(Function<QuoteStateTransitionMessagePayload,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

QUOTE_STATE_TRANSITION

static final String QUOTE_STATE_TRANSITION

discriminator value for QuoteStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getState

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

State of the Quote after the Transition State update action.

Returns:

state

getOldState

@Valid
@Valid StateReference getOldState()

State of the Quote before the Transition State update action.

Returns:

oldState

getForce

@NotNull
@NotNull Boolean getForce()

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

Returns:

force

setState

void setState(StateReference state)

State of the Quote after the Transition State update action.

Parameters:

state - value to be set

setOldState

void setOldState(StateReference oldState)

State of the Quote before the Transition State update action.

Parameters:

oldState - value to be set

setForce

void setForce(Boolean force)

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

Parameters:

force - value to be set

of

static QuoteStateTransitionMessagePayload of()

factory method

Returns:

instance of QuoteStateTransitionMessagePayload

of

static QuoteStateTransitionMessagePayload of(QuoteStateTransitionMessagePayload template)

factory method to create a shallow copy QuoteStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

QuoteStateTransitionMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static QuoteStateTransitionMessagePayload deepCopy(@Nullable
 QuoteStateTransitionMessagePayload template)

factory method to create a deep copy of QuoteStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static QuoteStateTransitionMessagePayloadBuilder builder()

builder factory method for QuoteStateTransitionMessagePayload

Returns:

builder

builder

static QuoteStateTransitionMessagePayloadBuilder builder(QuoteStateTransitionMessagePayload template)

create builder for QuoteStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withQuoteStateTransitionMessagePayload

default <T> T withQuoteStateTransitionMessagePayload(Function<QuoteStateTransitionMessagePayload,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<QuoteStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference