Package com.commercetools.api.models.order_edit

Interface StagedOrderImportLineItemStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderImportLineItemStateAction
extends StagedOrderUpdateAction

The import of States does not follow any predefined rules and should be only used if no transitions are defined. The quantity in the ItemStates must match the sum of all Line Item states' quantities.

Example to create an instance using the builder pattern

     StagedOrderImportLineItemStateAction stagedOrderImportLineItemStateAction = StagedOrderImportLineItemStateAction.builder()
             .plusState(stateBuilder -> stateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMPORT_LINE_ITEM_STATE	discriminator value for StagedOrderImportLineItemStateAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderImportLineItemStateActionBuilder	builder()	builder factory method for StagedOrderImportLineItemStateAction
static StagedOrderImportLineItemStateActionBuilder	builder(StagedOrderImportLineItemStateAction template)	create builder for StagedOrderImportLineItemStateAction instance
StagedOrderImportLineItemStateAction	copyDeep()
static StagedOrderImportLineItemStateAction	deepCopy(StagedOrderImportLineItemStateAction template)	factory method to create a deep copy of StagedOrderImportLineItemStateAction
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
@NotNull @Valid List<ItemState>	getState()	New status of the Line Items.
static StagedOrderImportLineItemStateAction	of()	factory method
static StagedOrderImportLineItemStateAction	of(StagedOrderImportLineItemStateAction template)	factory method to create a shallow copy StagedOrderImportLineItemStateAction
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setState(ItemState... state)	New status of the Line Items.
void	setState(List<ItemState> state)	New status of the Line Items.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderImportLineItemStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderImportLineItemStateAction(Function<StagedOrderImportLineItemStateAction,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

IMPORT_LINE_ITEM_STATE

static final String IMPORT_LINE_ITEM_STATE

discriminator value for StagedOrderImportLineItemStateAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

getState

@NotNull
@Valid
@NotNull @Valid List<ItemState> getState()

New status of the Line Items.

Returns:

state

setLineItemId

void setLineItemId(String lineItemId)

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - value to be set

setState

void setState(ItemState... state)

New status of the Line Items.

Parameters:

state - values to be set

setState

void setState(List<ItemState> state)

New status of the Line Items.

Parameters:

state - values to be set

of

static StagedOrderImportLineItemStateAction of()

factory method

Returns:

instance of StagedOrderImportLineItemStateAction

of

static StagedOrderImportLineItemStateAction of(StagedOrderImportLineItemStateAction template)

factory method to create a shallow copy StagedOrderImportLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderImportLineItemStateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderImportLineItemStateAction deepCopy(@Nullable
 StagedOrderImportLineItemStateAction template)

factory method to create a deep copy of StagedOrderImportLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderImportLineItemStateActionBuilder builder()

builder factory method for StagedOrderImportLineItemStateAction

Returns:

builder

builder

static StagedOrderImportLineItemStateActionBuilder builder(StagedOrderImportLineItemStateAction template)

create builder for StagedOrderImportLineItemStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderImportLineItemStateAction

default <T> T withStagedOrderImportLineItemStateAction(Function<StagedOrderImportLineItemStateAction,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<StagedOrderImportLineItemStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference