Package com.commercetools.api.models.order_edit

Interface StagedOrderTransitionStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderTransitionStateAction
extends StagedOrderUpdateAction

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed.

This update action produces the Order State Transition Message.

Example to create an instance using the builder pattern

     StagedOrderTransitionStateAction stagedOrderTransitionStateAction = StagedOrderTransitionStateAction.builder()
             .state(stateBuilder -> stateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSITION_STATE	discriminator value for StagedOrderTransitionStateAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderTransitionStateActionBuilder	builder()	builder factory method for StagedOrderTransitionStateAction
static StagedOrderTransitionStateActionBuilder	builder(StagedOrderTransitionStateAction template)	create builder for StagedOrderTransitionStateAction instance
StagedOrderTransitionStateAction	copyDeep()
static StagedOrderTransitionStateAction	deepCopy(StagedOrderTransitionStateAction template)	factory method to create a deep copy of StagedOrderTransitionStateAction
Boolean	getForce()	Set to true to turn off validation.
@NotNull @Valid StateResourceIdentifier	getState()	Value to set.
static StagedOrderTransitionStateAction	of()	factory method
static StagedOrderTransitionStateAction	of(StagedOrderTransitionStateAction template)	factory method to create a shallow copy StagedOrderTransitionStateAction
void	setForce(Boolean force)	Set to true to turn off validation.
void	setState(StateResourceIdentifier state)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderTransitionStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderTransitionStateAction(Function<StagedOrderTransitionStateAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

TRANSITION_STATE

static final String TRANSITION_STATE

discriminator value for StagedOrderTransitionStateAction

See Also:

• Constant Field Values

Method Details

getState

@NotNull
@Valid
@NotNull @Valid StateResourceIdentifier getState()

Value to set. If there is no State yet, the new State must be an initial State.

Returns:

state

getForce

Boolean getForce()

Set to true to turn off validation.

Returns:

force

setState

void setState(StateResourceIdentifier state)

Value to set. If there is no State yet, the new State must be an initial State.

Parameters:

state - value to be set

setForce

void setForce(Boolean force)

Set to true to turn off validation.

Parameters:

force - value to be set

of

static StagedOrderTransitionStateAction of()

factory method

Returns:

instance of StagedOrderTransitionStateAction

of

static StagedOrderTransitionStateAction of(StagedOrderTransitionStateAction template)

factory method to create a shallow copy StagedOrderTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderTransitionStateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderTransitionStateAction deepCopy(@Nullable
 StagedOrderTransitionStateAction template)

factory method to create a deep copy of StagedOrderTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderTransitionStateActionBuilder builder()

builder factory method for StagedOrderTransitionStateAction

Returns:

builder

builder

static StagedOrderTransitionStateActionBuilder builder(StagedOrderTransitionStateAction template)

create builder for StagedOrderTransitionStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderTransitionStateAction

default <T> T withStagedOrderTransitionStateAction(Function<StagedOrderTransitionStateAction,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<StagedOrderTransitionStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference