Package com.commercetools.api.models.cart

Interface CartSetLineItemCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetLineItemCustomFieldActionImpl

public interface CartSetLineItemCustomFieldAction
extends CartUpdateAction

CartSetLineItemCustomFieldAction Example to create an instance using the builder pattern

     CartSetLineItemCustomFieldAction cartSetLineItemCustomFieldAction = CartSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

SET_LINE_ITEM_CUSTOM_FIELD

static final String SET_LINE_ITEM_CUSTOM_FIELD

discriminator value for CartSetLineItemCustomFieldAction

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

factory method

Returns:

instance of CartSetLineItemCustomFieldAction

of

static CartSetLineItemCustomFieldAction of(CartSetLineItemCustomFieldAction template)

factory method to create a shallow copy CartSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetLineItemCustomFieldAction deepCopy(@Nullable
 CartSetLineItemCustomFieldAction template)

factory method to create a deep copy of CartSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetLineItemCustomFieldActionBuilder builder()

builder factory method for CartSetLineItemCustomFieldAction

Returns:

builder

builder

static CartSetLineItemCustomFieldActionBuilder builder(CartSetLineItemCustomFieldAction template)

create builder for CartSetLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetLineItemCustomFieldAction

default <T> T withCartSetLineItemCustomFieldAction(Function<CartSetLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetLineItemCustomFieldAction ofUnset(String name,
 String lineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference