Package com.commercetools.api.models.cart

Interface CartRemoveItemShippingAddressAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartRemoveItemShippingAddressAction
extends CartUpdateAction

An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.

Example to create an instance using the builder pattern

     CartRemoveItemShippingAddressAction cartRemoveItemShippingAddressAction = CartRemoveItemShippingAddressAction.builder()
             .addressKey("{addressKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_ITEM_SHIPPING_ADDRESS	discriminator value for CartRemoveItemShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static CartRemoveItemShippingAddressActionBuilder	builder()	builder factory method for CartRemoveItemShippingAddressAction
static CartRemoveItemShippingAddressActionBuilder	builder(CartRemoveItemShippingAddressAction template)	create builder for CartRemoveItemShippingAddressAction instance
CartRemoveItemShippingAddressAction	copyDeep()
static CartRemoveItemShippingAddressAction	deepCopy(CartRemoveItemShippingAddressAction template)	factory method to create a deep copy of CartRemoveItemShippingAddressAction
@NotNull String	getAddressKey()	key of the Address to remove from itemShippingAddresses.
static CartRemoveItemShippingAddressAction	of()	factory method
static CartRemoveItemShippingAddressAction	of(CartRemoveItemShippingAddressAction template)	factory method to create a shallow copy CartRemoveItemShippingAddressAction
void	setAddressKey(String addressKey)	key of the Address to remove from itemShippingAddresses.
static com.fasterxml.jackson.core.type.TypeReference<CartRemoveItemShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartRemoveItemShippingAddressAction(Function<CartRemoveItemShippingAddressAction,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

REMOVE_ITEM_SHIPPING_ADDRESS

static final String REMOVE_ITEM_SHIPPING_ADDRESS

discriminator value for CartRemoveItemShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressKey

@NotNull
@NotNull String getAddressKey()

key of the Address to remove from itemShippingAddresses.

Returns:

addressKey

setAddressKey

void setAddressKey(String addressKey)

key of the Address to remove from itemShippingAddresses.

Parameters:

addressKey - value to be set

of

static CartRemoveItemShippingAddressAction of()

factory method

Returns:

instance of CartRemoveItemShippingAddressAction

of

static CartRemoveItemShippingAddressAction of(CartRemoveItemShippingAddressAction template)

factory method to create a shallow copy CartRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartRemoveItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartRemoveItemShippingAddressAction deepCopy(@Nullable
 CartRemoveItemShippingAddressAction template)

factory method to create a deep copy of CartRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartRemoveItemShippingAddressActionBuilder builder()

builder factory method for CartRemoveItemShippingAddressAction

Returns:

builder

builder

static CartRemoveItemShippingAddressActionBuilder builder(CartRemoveItemShippingAddressAction template)

create builder for CartRemoveItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartRemoveItemShippingAddressAction

default <T> T withCartRemoveItemShippingAddressAction(Function<CartRemoveItemShippingAddressAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference