Package com.commercetools.api.models.cart

Interface CartSetDeliveryAddressCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetDeliveryAddressCustomFieldActionImpl

public interface CartSetDeliveryAddressCustomFieldAction
extends CartUpdateAction

CartSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern

     CartSetDeliveryAddressCustomFieldAction cartSetDeliveryAddressCustomFieldAction = CartSetDeliveryAddressCustomFieldAction.builder()
             .deliveryId("{deliveryId}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_ADDRESS_CUSTOM_FIELD	discriminator value for CartSetDeliveryAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CartSetDeliveryAddressCustomFieldActionBuilder	builder()	builder factory method for CartSetDeliveryAddressCustomFieldAction
static CartSetDeliveryAddressCustomFieldActionBuilder	builder(CartSetDeliveryAddressCustomFieldAction template)	create builder for CartSetDeliveryAddressCustomFieldAction instance
static CartSetDeliveryAddressCustomFieldAction	deepCopy(CartSetDeliveryAddressCustomFieldAction template)	factory method to create a deep copy of CartSetDeliveryAddressCustomFieldAction
@NotNull String	getDeliveryId()	id of the Delivery.
@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 CartSetDeliveryAddressCustomFieldAction	of()	factory method
static CartSetDeliveryAddressCustomFieldAction	of(CartSetDeliveryAddressCustomFieldAction template)	factory method to create a shallow copy CartSetDeliveryAddressCustomFieldAction
static CartSetDeliveryAddressCustomFieldAction	ofUnset(String name, String deliveryId)
void	setDeliveryId(String deliveryId)	id of the Delivery.
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<CartSetDeliveryAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetDeliveryAddressCustomFieldAction(Function<CartSetDeliveryAddressCustomFieldAction,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_DELIVERY_ADDRESS_CUSTOM_FIELD

static final String SET_DELIVERY_ADDRESS_CUSTOM_FIELD

discriminator value for CartSetDeliveryAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

id of the Delivery.

Returns:

deliveryId

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

setDeliveryId

void setDeliveryId(String deliveryId)

id of the Delivery.

Parameters:

deliveryId - 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 CartSetDeliveryAddressCustomFieldAction of()

factory method

Returns:

instance of CartSetDeliveryAddressCustomFieldAction

of

static CartSetDeliveryAddressCustomFieldAction of(CartSetDeliveryAddressCustomFieldAction template)

factory method to create a shallow copy CartSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetDeliveryAddressCustomFieldAction deepCopy(@Nullable
 CartSetDeliveryAddressCustomFieldAction template)

factory method to create a deep copy of CartSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetDeliveryAddressCustomFieldActionBuilder builder()

builder factory method for CartSetDeliveryAddressCustomFieldAction

Returns:

builder

builder

static CartSetDeliveryAddressCustomFieldActionBuilder builder(CartSetDeliveryAddressCustomFieldAction template)

create builder for CartSetDeliveryAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetDeliveryAddressCustomFieldAction

default <T> T withCartSetDeliveryAddressCustomFieldAction(Function<CartSetDeliveryAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetDeliveryAddressCustomFieldAction ofUnset(String name,
 String deliveryId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference