Package com.commercetools.api.models.order_edit

Interface StagedOrderImportCustomLineItemStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderImportCustomLineItemStateAction
extends StagedOrderUpdateAction

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

Example to create an instance using the builder pattern

     StagedOrderImportCustomLineItemStateAction stagedOrderImportCustomLineItemStateAction = StagedOrderImportCustomLineItemStateAction.builder()
             .plusState(stateBuilder -> stateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMPORT_CUSTOM_LINE_ITEM_STATE	discriminator value for StagedOrderImportCustomLineItemStateAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderImportCustomLineItemStateActionBuilder	builder()	builder factory method for StagedOrderImportCustomLineItemStateAction
static StagedOrderImportCustomLineItemStateActionBuilder	builder(StagedOrderImportCustomLineItemStateAction template)	create builder for StagedOrderImportCustomLineItemStateAction instance
StagedOrderImportCustomLineItemStateAction	copyDeep()
static StagedOrderImportCustomLineItemStateAction	deepCopy(StagedOrderImportCustomLineItemStateAction template)	factory method to create a deep copy of StagedOrderImportCustomLineItemStateAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
@NotNull @Valid List<ItemState>	getState()	New status of the Custom Line Items.
static StagedOrderImportCustomLineItemStateAction	of()	factory method
static StagedOrderImportCustomLineItemStateAction	of(StagedOrderImportCustomLineItemStateAction template)	factory method to create a shallow copy StagedOrderImportCustomLineItemStateAction
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
void	setState(ItemState... state)	New status of the Custom Line Items.
void	setState(List<ItemState> state)	New status of the Custom Line Items.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderImportCustomLineItemStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderImportCustomLineItemStateAction(Function<StagedOrderImportCustomLineItemStateAction,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_CUSTOM_LINE_ITEM_STATE

static final String IMPORT_CUSTOM_LINE_ITEM_STATE

discriminator value for StagedOrderImportCustomLineItemStateAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

String getCustomLineItemId()

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemKey

getState

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

New status of the Custom Line Items.

Returns:

state

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemKey - value to be set

setState

void setState(ItemState... state)

New status of the Custom Line Items.

Parameters:

state - values to be set

setState

void setState(List<ItemState> state)

New status of the Custom Line Items.

Parameters:

state - values to be set

of

static StagedOrderImportCustomLineItemStateAction of()

factory method

Returns:

instance of StagedOrderImportCustomLineItemStateAction

of

static StagedOrderImportCustomLineItemStateAction of(StagedOrderImportCustomLineItemStateAction template)

factory method to create a shallow copy StagedOrderImportCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderImportCustomLineItemStateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderImportCustomLineItemStateAction deepCopy(@Nullable
 StagedOrderImportCustomLineItemStateAction template)

factory method to create a deep copy of StagedOrderImportCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderImportCustomLineItemStateActionBuilder builder()

builder factory method for StagedOrderImportCustomLineItemStateAction

Returns:

builder

builder

static StagedOrderImportCustomLineItemStateActionBuilder builder(StagedOrderImportCustomLineItemStateAction template)

create builder for StagedOrderImportCustomLineItemStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderImportCustomLineItemStateAction

default <T> T withStagedOrderImportCustomLineItemStateAction(Function<StagedOrderImportCustomLineItemStateAction,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<StagedOrderImportCustomLineItemStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference