Package com.commercetools.api.models.cart

Interface CartSetCustomLineItemCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetCustomLineItemCustomFieldActionImpl

public interface CartSetCustomLineItemCustomFieldAction
extends CartUpdateAction

CartSetCustomLineItemCustomFieldAction Example to create an instance using the builder pattern

     CartSetCustomLineItemCustomFieldAction cartSetCustomLineItemCustomFieldAction = CartSetCustomLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD	discriminator value for CartSetCustomLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CartSetCustomLineItemCustomFieldActionBuilder	builder()	builder factory method for CartSetCustomLineItemCustomFieldAction
static CartSetCustomLineItemCustomFieldActionBuilder	builder(CartSetCustomLineItemCustomFieldAction template)	create builder for CartSetCustomLineItemCustomFieldAction instance
static CartSetCustomLineItemCustomFieldAction	deepCopy(CartSetCustomLineItemCustomFieldAction template)	factory method to create a deep copy of CartSetCustomLineItemCustomFieldAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem 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 CartSetCustomLineItemCustomFieldAction	of()	factory method
static CartSetCustomLineItemCustomFieldAction	of(CartSetCustomLineItemCustomFieldAction template)	factory method to create a shallow copy CartSetCustomLineItemCustomFieldAction
static CartSetCustomLineItemCustomFieldAction	ofUnset(String name, String customLineItemId)
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem 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<CartSetCustomLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetCustomLineItemCustomFieldAction(Function<CartSetCustomLineItemCustomFieldAction,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_CUSTOM_LINE_ITEM_CUSTOM_FIELD

static final String SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD

discriminator value for CartSetCustomLineItemCustomFieldAction

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

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

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

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

factory method

Returns:

instance of CartSetCustomLineItemCustomFieldAction

of

static CartSetCustomLineItemCustomFieldAction of(CartSetCustomLineItemCustomFieldAction template)

factory method to create a shallow copy CartSetCustomLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetCustomLineItemCustomFieldAction deepCopy(@Nullable
 CartSetCustomLineItemCustomFieldAction template)

factory method to create a deep copy of CartSetCustomLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetCustomLineItemCustomFieldActionBuilder builder()

builder factory method for CartSetCustomLineItemCustomFieldAction

Returns:

builder

builder

static CartSetCustomLineItemCustomFieldActionBuilder builder(CartSetCustomLineItemCustomFieldAction template)

create builder for CartSetCustomLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetCustomLineItemCustomFieldAction

default <T> T withCartSetCustomLineItemCustomFieldAction(Function<CartSetCustomLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetCustomLineItemCustomFieldAction ofUnset(String name,
 String customLineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference