Package com.commercetools.api.models.cart

Interface CartSetItemShippingAddressCustomFieldAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetItemShippingAddressCustomFieldActionImpl

public interface CartSetItemShippingAddressCustomFieldAction
extends CartUpdateAction

CartSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     CartSetItemShippingAddressCustomFieldAction cartSetItemShippingAddressCustomFieldAction = CartSetItemShippingAddressCustomFieldAction.builder()
             .addressKey("{addressKey}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD	discriminator value for CartSetItemShippingAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static CartSetItemShippingAddressCustomFieldActionBuilder	builder()	builder factory method for CartSetItemShippingAddressCustomFieldAction
static CartSetItemShippingAddressCustomFieldActionBuilder	builder(CartSetItemShippingAddressCustomFieldAction template)	create builder for CartSetItemShippingAddressCustomFieldAction instance
static CartSetItemShippingAddressCustomFieldAction	deepCopy(CartSetItemShippingAddressCustomFieldAction template)	factory method to create a deep copy of CartSetItemShippingAddressCustomFieldAction
@NotNull String	getAddressKey()	key of the Address in itemShippingAddress.
@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 CartSetItemShippingAddressCustomFieldAction	of()	factory method
static CartSetItemShippingAddressCustomFieldAction	of(CartSetItemShippingAddressCustomFieldAction template)	factory method to create a shallow copy CartSetItemShippingAddressCustomFieldAction
static CartSetItemShippingAddressCustomFieldAction	ofUnset(String name, String addressKey)
void	setAddressKey(String addressKey)	key of the Address in itemShippingAddress.
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<CartSetItemShippingAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetItemShippingAddressCustomFieldAction(Function<CartSetItemShippingAddressCustomFieldAction,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_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

static final String SET_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for CartSetItemShippingAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getAddressKey

@NotNull
@NotNull String getAddressKey()

key of the Address in itemShippingAddress.

Returns:

addressKey

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

setAddressKey

void setAddressKey(String addressKey)

key of the Address in itemShippingAddress.

Parameters:

addressKey - 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 CartSetItemShippingAddressCustomFieldAction of()

factory method

Returns:

instance of CartSetItemShippingAddressCustomFieldAction

of

static CartSetItemShippingAddressCustomFieldAction of(CartSetItemShippingAddressCustomFieldAction template)

factory method to create a shallow copy CartSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetItemShippingAddressCustomFieldAction deepCopy(@Nullable
 CartSetItemShippingAddressCustomFieldAction template)

factory method to create a deep copy of CartSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetItemShippingAddressCustomFieldActionBuilder builder()

builder factory method for CartSetItemShippingAddressCustomFieldAction

Returns:

builder

builder

static CartSetItemShippingAddressCustomFieldActionBuilder builder(CartSetItemShippingAddressCustomFieldAction template)

create builder for CartSetItemShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetItemShippingAddressCustomFieldAction

default <T> T withCartSetItemShippingAddressCustomFieldAction(Function<CartSetItemShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static CartSetItemShippingAddressCustomFieldAction ofUnset(String name,
 String addressKey)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference