Package com.commercetools.api.models.cart

Interface CartSetShippingAddressCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetShippingAddressCustomFieldActionImpl

public interface CartSetShippingAddressCustomFieldAction
extends CartUpdateAction

CartSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     CartSetShippingAddressCustomFieldAction cartSetShippingAddressCustomFieldAction = CartSetShippingAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_CUSTOM_FIELD	discriminator value for CartSetShippingAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingAddressCustomFieldActionBuilder	builder()	builder factory method for CartSetShippingAddressCustomFieldAction
static CartSetShippingAddressCustomFieldActionBuilder	builder(CartSetShippingAddressCustomFieldAction template)	create builder for CartSetShippingAddressCustomFieldAction instance
static CartSetShippingAddressCustomFieldAction	deepCopy(CartSetShippingAddressCustomFieldAction template)	factory method to create a deep copy of CartSetShippingAddressCustomFieldAction
@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 CartSetShippingAddressCustomFieldAction	of()	factory method
static CartSetShippingAddressCustomFieldAction	of(CartSetShippingAddressCustomFieldAction template)	factory method to create a shallow copy CartSetShippingAddressCustomFieldAction
static CartSetShippingAddressCustomFieldAction	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<CartSetShippingAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingAddressCustomFieldAction(Function<CartSetShippingAddressCustomFieldAction,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_SHIPPING_ADDRESS_CUSTOM_FIELD

static final String SET_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for CartSetShippingAddressCustomFieldAction

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

factory method

Returns:

instance of CartSetShippingAddressCustomFieldAction

of

static CartSetShippingAddressCustomFieldAction of(CartSetShippingAddressCustomFieldAction template)

factory method to create a shallow copy CartSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetShippingAddressCustomFieldAction deepCopy(@Nullable
 CartSetShippingAddressCustomFieldAction template)

factory method to create a deep copy of CartSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingAddressCustomFieldActionBuilder builder()

builder factory method for CartSetShippingAddressCustomFieldAction

Returns:

builder

builder

static CartSetShippingAddressCustomFieldActionBuilder builder(CartSetShippingAddressCustomFieldAction template)

create builder for CartSetShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingAddressCustomFieldAction

default <T> T withCartSetShippingAddressCustomFieldAction(Function<CartSetShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetShippingAddressCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference