Package com.commercetools.api.models.order_edit

Interface StagedOrderAddItemShippingAddressAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderAddItemShippingAddressAction
extends StagedOrderUpdateAction

Adds an address to an Order when shipping to multiple addresses is desired.

Example to create an instance using the builder pattern

     StagedOrderAddItemShippingAddressAction stagedOrderAddItemShippingAddressAction = StagedOrderAddItemShippingAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ITEM_SHIPPING_ADDRESS	discriminator value for StagedOrderAddItemShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderAddItemShippingAddressActionBuilder	builder()	builder factory method for StagedOrderAddItemShippingAddressAction
static StagedOrderAddItemShippingAddressActionBuilder	builder(StagedOrderAddItemShippingAddressAction template)	create builder for StagedOrderAddItemShippingAddressAction instance
static StagedOrderAddItemShippingAddressAction	deepCopy(StagedOrderAddItemShippingAddressAction template)	factory method to create a deep copy of StagedOrderAddItemShippingAddressAction
@NotNull @Valid BaseAddress	getAddress()	Address to append to itemShippingAddresses.
static StagedOrderAddItemShippingAddressAction	of()	factory method
static StagedOrderAddItemShippingAddressAction	of(StagedOrderAddItemShippingAddressAction template)	factory method to create a shallow copy StagedOrderAddItemShippingAddressAction
void	setAddress(BaseAddress address)	Address to append to itemShippingAddresses.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderAddItemShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderAddItemShippingAddressAction(Function<StagedOrderAddItemShippingAddressAction,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

ADD_ITEM_SHIPPING_ADDRESS

static final String ADD_ITEM_SHIPPING_ADDRESS

discriminator value for StagedOrderAddItemShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddress

@NotNull
@Valid
@NotNull @Valid BaseAddress getAddress()

Address to append to itemShippingAddresses. The new Address must have a key that is unique across this Order.

Returns:

address

setAddress

void setAddress(BaseAddress address)

Address to append to itemShippingAddresses. The new Address must have a key that is unique across this Order.

Parameters:

address - value to be set

of

static StagedOrderAddItemShippingAddressAction of()

factory method

Returns:

instance of StagedOrderAddItemShippingAddressAction

of

static StagedOrderAddItemShippingAddressAction of(StagedOrderAddItemShippingAddressAction template)

factory method to create a shallow copy StagedOrderAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderAddItemShippingAddressAction deepCopy(@Nullable
 StagedOrderAddItemShippingAddressAction template)

factory method to create a deep copy of StagedOrderAddItemShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderAddItemShippingAddressActionBuilder builder()

builder factory method for StagedOrderAddItemShippingAddressAction

Returns:

builder

builder

static StagedOrderAddItemShippingAddressActionBuilder builder(StagedOrderAddItemShippingAddressAction template)

create builder for StagedOrderAddItemShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderAddItemShippingAddressAction

default <T> T withStagedOrderAddItemShippingAddressAction(Function<StagedOrderAddItemShippingAddressAction,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<StagedOrderAddItemShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference