Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetLineItemCustomFieldActionImpl

public interface StagedOrderSetLineItemCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetLineItemCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetLineItemCustomFieldAction stagedOrderSetLineItemCustomFieldAction = StagedOrderSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_CUSTOM_FIELD	discriminator value for StagedOrderSetLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetLineItemCustomFieldActionBuilder	builder()	builder factory method for StagedOrderSetLineItemCustomFieldAction
static StagedOrderSetLineItemCustomFieldActionBuilder	builder(StagedOrderSetLineItemCustomFieldAction template)	create builder for StagedOrderSetLineItemCustomFieldAction instance
static StagedOrderSetLineItemCustomFieldAction	deepCopy(StagedOrderSetLineItemCustomFieldAction template)	factory method to create a deep copy of StagedOrderSetLineItemCustomFieldAction
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static StagedOrderSetLineItemCustomFieldAction	of()	factory method
static StagedOrderSetLineItemCustomFieldAction	of(StagedOrderSetLineItemCustomFieldAction template)	factory method to create a shallow copy StagedOrderSetLineItemCustomFieldAction
static StagedOrderSetLineItemCustomFieldAction	ofUnset(String name, String lineItemId)
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetLineItemCustomFieldAction(Function<StagedOrderSetLineItemCustomFieldAction,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

SET_LINE_ITEM_CUSTOM_FIELD

static final String SET_LINE_ITEM_CUSTOM_FIELD

discriminator value for StagedOrderSetLineItemCustomFieldAction

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

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

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

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static StagedOrderSetLineItemCustomFieldAction of()

factory method

Returns:

instance of StagedOrderSetLineItemCustomFieldAction

of

static StagedOrderSetLineItemCustomFieldAction of(StagedOrderSetLineItemCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetLineItemCustomFieldAction deepCopy(@Nullable
 StagedOrderSetLineItemCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetLineItemCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetLineItemCustomFieldAction

Returns:

builder

builder

static StagedOrderSetLineItemCustomFieldActionBuilder builder(StagedOrderSetLineItemCustomFieldAction template)

create builder for StagedOrderSetLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetLineItemCustomFieldAction

default <T> T withStagedOrderSetLineItemCustomFieldAction(Function<StagedOrderSetLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetLineItemCustomFieldAction ofUnset(String name,
 String lineItemId)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetLineItemCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference