Package com.commercetools.api.models.product

Interface ProductTransitionStateAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductTransitionStateActionImpl

public interface ProductTransitionStateAction
extends ProductUpdateAction

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. Produces the ProductStateTransition Message.

Example to create an instance using the builder pattern

     ProductTransitionStateAction productTransitionStateAction = ProductTransitionStateAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ProductTransitionStateActionBuilder	builder()	builder factory method for ProductTransitionStateAction
static ProductTransitionStateActionBuilder	builder(ProductTransitionStateAction template)	create builder for ProductTransitionStateAction instance
static ProductTransitionStateAction	deepCopy(ProductTransitionStateAction template)	factory method to create a deep copy of ProductTransitionStateAction
Boolean	getForce()	If true, validations are disabled.
@Valid StateResourceIdentifier	getState()	The State to transition to.
static ProductTransitionStateAction	of()	factory method
static ProductTransitionStateAction	of(ProductTransitionStateAction template)	factory method to create a shallow copy ProductTransitionStateAction
void	setForce(Boolean force)	If true, validations are disabled.
void	setState(StateResourceIdentifier state)	The State to transition to.
static com.fasterxml.jackson.core.type.TypeReference<ProductTransitionStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductTransitionStateAction(Function<ProductTransitionStateAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.ProductUpdateAction

getAction, withProductUpdateAction

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

get

Field Details

TRANSITION_STATE

static final String TRANSITION_STATE

discriminator value for ProductTransitionStateAction

See Also:

• Constant Field Values

Method Details

getState

@Valid
@Valid StateResourceIdentifier getState()

The State to transition to. If there is no existing State, this must be an initial State.

Returns:

state

getForce

Boolean getForce()

If true, validations are disabled.

Returns:

force

setState

void setState(StateResourceIdentifier state)

The State to transition to. If there is no existing State, this must be an initial State.

Parameters:

state - value to be set

setForce

void setForce(Boolean force)

If true, validations are disabled.

Parameters:

force - value to be set

of

static ProductTransitionStateAction of()

factory method

Returns:

instance of ProductTransitionStateAction

of

static ProductTransitionStateAction of(ProductTransitionStateAction template)

factory method to create a shallow copy ProductTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductTransitionStateAction deepCopy(@Nullable
 ProductTransitionStateAction template)

factory method to create a deep copy of ProductTransitionStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductTransitionStateActionBuilder builder()

builder factory method for ProductTransitionStateAction

Returns:

builder

builder

static ProductTransitionStateActionBuilder builder(ProductTransitionStateAction template)

create builder for ProductTransitionStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductTransitionStateAction

default <T> T withProductTransitionStateAction(Function<ProductTransitionStateAction,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<ProductTransitionStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference