Package com.commercetools.api.models.message

Interface ProductStateTransitionMessagePayload

All Superinterfaces:

MessagePayload

All Known Implementing Classes:

ProductStateTransitionMessagePayloadImpl

public interface ProductStateTransitionMessagePayload
extends MessagePayload

Generated after a successful Transition State update action.

Example to create an instance using the builder pattern

     ProductStateTransitionMessagePayload productStateTransitionMessagePayload = ProductStateTransitionMessagePayload.builder()
             .state(stateBuilder -> stateBuilder)
             .force(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRODUCT_STATE_TRANSITION	discriminator value for ProductStateTransitionMessagePayload

Method Summary

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

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

getType, withMessagePayload

Field Details

PRODUCT_STATE_TRANSITION

static final String PRODUCT_STATE_TRANSITION

discriminator value for ProductStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getState

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

Product State after the Transition State update action.

Returns:

state

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)

Product State 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 Transition State update action.

Parameters:

force - value to be set

of

static ProductStateTransitionMessagePayload of()

factory method

Returns:

instance of ProductStateTransitionMessagePayload

of

static ProductStateTransitionMessagePayload of(ProductStateTransitionMessagePayload template)

factory method to create a shallow copy ProductStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductStateTransitionMessagePayload deepCopy(@Nullable
 ProductStateTransitionMessagePayload template)

factory method to create a deep copy of ProductStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductStateTransitionMessagePayloadBuilder builder()

builder factory method for ProductStateTransitionMessagePayload

Returns:

builder

builder

static ProductStateTransitionMessagePayloadBuilder builder(ProductStateTransitionMessagePayload template)

create builder for ProductStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductStateTransitionMessagePayload

default <T> T withProductStateTransitionMessagePayload(Function<ProductStateTransitionMessagePayload,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<ProductStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference