Package com.commercetools.api.models.me

Interface MyCartRemoveItemShippingAddressAction

All Superinterfaces:

MyCartUpdateAction, ResourceUpdateAction<MyCartUpdateAction>

All Known Implementing Classes:

MyCartRemoveItemShippingAddressActionImpl

public interface MyCartRemoveItemShippingAddressAction
extends MyCartUpdateAction

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

     MyCartRemoveItemShippingAddressAction myCartRemoveItemShippingAddressAction = MyCartRemoveItemShippingAddressAction.builder()
             .addressKey("{addressKey}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyCartRemoveItemShippingAddressActionBuilder	builder()	builder factory method for MyCartRemoveItemShippingAddressAction
static MyCartRemoveItemShippingAddressActionBuilder	builder(MyCartRemoveItemShippingAddressAction template)	create builder for MyCartRemoveItemShippingAddressAction instance
static MyCartRemoveItemShippingAddressAction	deepCopy(MyCartRemoveItemShippingAddressAction template)	factory method to create a deep copy of MyCartRemoveItemShippingAddressAction
@NotNull String	getAddressKey()	key of the Address to remove from itemShippingAddresses.
static MyCartRemoveItemShippingAddressAction	of()	factory method
static MyCartRemoveItemShippingAddressAction	of(MyCartRemoveItemShippingAddressAction template)	factory method to create a shallow copy MyCartRemoveItemShippingAddressAction
void	setAddressKey(String addressKey)	key of the Address to remove from itemShippingAddresses.
static com.fasterxml.jackson.core.type.TypeReference<MyCartRemoveItemShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCartRemoveItemShippingAddressAction(Function<MyCartRemoveItemShippingAddressAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyCartUpdateAction

getAction, withMyCartUpdateAction

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 MyCartRemoveItemShippingAddressAction

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

factory method

Returns:

instance of MyCartRemoveItemShippingAddressAction

of

static MyCartRemoveItemShippingAddressAction of(MyCartRemoveItemShippingAddressAction template)

factory method to create a shallow copy MyCartRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyCartRemoveItemShippingAddressAction deepCopy(@Nullable
 MyCartRemoveItemShippingAddressAction template)

factory method to create a deep copy of MyCartRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCartRemoveItemShippingAddressActionBuilder builder()

builder factory method for MyCartRemoveItemShippingAddressAction

Returns:

builder

builder

static MyCartRemoveItemShippingAddressActionBuilder builder(MyCartRemoveItemShippingAddressAction template)

create builder for MyCartRemoveItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCartRemoveItemShippingAddressAction

default <T> T withMyCartRemoveItemShippingAddressAction(Function<MyCartRemoveItemShippingAddressAction,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<MyCartRemoveItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference