Package com.commercetools.api.models.cart

Interface CartSetCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetCustomFieldActionImpl

public interface CartSetCustomFieldAction
extends CartUpdateAction

CartSetCustomFieldAction Example to create an instance using the builder pattern

     CartSetCustomFieldAction cartSetCustomFieldAction = CartSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_FIELD	discriminator value for CartSetCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CartSetCustomFieldActionBuilder	builder()	builder factory method for CartSetCustomFieldAction
static CartSetCustomFieldActionBuilder	builder(CartSetCustomFieldAction template)	create builder for CartSetCustomFieldAction instance
static CartSetCustomFieldAction	deepCopy(CartSetCustomFieldAction template)	factory method to create a deep copy of CartSetCustomFieldAction
@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 CartSetCustomFieldAction	of()	factory method
static CartSetCustomFieldAction	of(CartSetCustomFieldAction template)	factory method to create a shallow copy CartSetCustomFieldAction
static CartSetCustomFieldAction	ofUnset(String name)
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<CartSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetCustomFieldAction(Function<CartSetCustomFieldAction,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_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for CartSetCustomFieldAction

See Also:

• Constant Field Values

Method Details

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

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

factory method

Returns:

instance of CartSetCustomFieldAction

of

static CartSetCustomFieldAction of(CartSetCustomFieldAction template)

factory method to create a shallow copy CartSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetCustomFieldAction deepCopy(@Nullable
 CartSetCustomFieldAction template)

factory method to create a deep copy of CartSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetCustomFieldActionBuilder builder()

builder factory method for CartSetCustomFieldAction

Returns:

builder

builder

static CartSetCustomFieldActionBuilder builder(CartSetCustomFieldAction template)

create builder for CartSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetCustomFieldAction

default <T> T withCartSetCustomFieldAction(Function<CartSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference