Package com.commercetools.api.models.order_edit

Interface StagedOrderRemoveItemShippingAddressAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderRemoveItemShippingAddressAction
extends StagedOrderUpdateAction

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

     StagedOrderRemoveItemShippingAddressAction stagedOrderRemoveItemShippingAddressAction = StagedOrderRemoveItemShippingAddressAction.builder()
             .addressKey("{addressKey}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

REMOVE_ITEM_SHIPPING_ADDRESS

static final String REMOVE_ITEM_SHIPPING_ADDRESS

discriminator value for StagedOrderRemoveItemShippingAddressAction

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

factory method

Returns:

instance of StagedOrderRemoveItemShippingAddressAction

of

static StagedOrderRemoveItemShippingAddressAction of(StagedOrderRemoveItemShippingAddressAction template)

factory method to create a shallow copy StagedOrderRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderRemoveItemShippingAddressAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderRemoveItemShippingAddressAction deepCopy(@Nullable
 StagedOrderRemoveItemShippingAddressAction template)

factory method to create a deep copy of StagedOrderRemoveItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderRemoveItemShippingAddressActionBuilder builder()

builder factory method for StagedOrderRemoveItemShippingAddressAction

Returns:

builder

builder

static StagedOrderRemoveItemShippingAddressActionBuilder builder(StagedOrderRemoveItemShippingAddressAction template)

create builder for StagedOrderRemoveItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderRemoveItemShippingAddressAction

default <T> T withStagedOrderRemoveItemShippingAddressAction(Function<StagedOrderRemoveItemShippingAddressAction,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<StagedOrderRemoveItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference