Package com.commercetools.api.models.order

Interface OrderImportCustomLineItemStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderImportCustomLineItemStateActionImpl

public interface OrderImportCustomLineItemStateAction
extends OrderUpdateAction

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 Custom Line Item states' quantities.

Example to create an instance using the builder pattern

     OrderImportCustomLineItemStateAction orderImportCustomLineItemStateAction = OrderImportCustomLineItemStateAction.builder()
             .plusState(stateBuilder -> stateBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderImportCustomLineItemStateActionBuilder	builder()	builder factory method for OrderImportCustomLineItemStateAction
static OrderImportCustomLineItemStateActionBuilder	builder(OrderImportCustomLineItemStateAction template)	create builder for OrderImportCustomLineItemStateAction instance
static OrderImportCustomLineItemStateAction	deepCopy(OrderImportCustomLineItemStateAction template)	factory method to create a deep copy of OrderImportCustomLineItemStateAction
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 OrderImportCustomLineItemStateAction	of()	factory method
static OrderImportCustomLineItemStateAction	of(OrderImportCustomLineItemStateAction template)	factory method to create a shallow copy OrderImportCustomLineItemStateAction
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<OrderImportCustomLineItemStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderImportCustomLineItemStateAction(Function<OrderImportCustomLineItemStateAction,T> helper)	accessor map function

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

getAction, withOrderUpdateAction

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

get

Field Details

IMPORT_CUSTOM_LINE_ITEM_STATE

static final String IMPORT_CUSTOM_LINE_ITEM_STATE

discriminator value for OrderImportCustomLineItemStateAction

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 OrderImportCustomLineItemStateAction of()

factory method

Returns:

instance of OrderImportCustomLineItemStateAction

of

static OrderImportCustomLineItemStateAction of(OrderImportCustomLineItemStateAction template)

factory method to create a shallow copy OrderImportCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderImportCustomLineItemStateAction deepCopy(@Nullable
 OrderImportCustomLineItemStateAction template)

factory method to create a deep copy of OrderImportCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderImportCustomLineItemStateActionBuilder builder()

builder factory method for OrderImportCustomLineItemStateAction

Returns:

builder

builder

static OrderImportCustomLineItemStateActionBuilder builder(OrderImportCustomLineItemStateAction template)

create builder for OrderImportCustomLineItemStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderImportCustomLineItemStateAction

default <T> T withOrderImportCustomLineItemStateAction(Function<OrderImportCustomLineItemStateAction,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<OrderImportCustomLineItemStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference