Package com.commercetools.api.models.order_edit

Interface StagedOrderSetDeliveryAddressAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetDeliveryAddressAction
extends StagedOrderUpdateAction

Produces the DeliveryAddressSet Message.

Example to create an instance using the builder pattern

     StagedOrderSetDeliveryAddressAction stagedOrderSetDeliveryAddressAction = StagedOrderSetDeliveryAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_ADDRESS	discriminator value for StagedOrderSetDeliveryAddressAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetDeliveryAddressActionBuilder	builder()	builder factory method for StagedOrderSetDeliveryAddressAction
static StagedOrderSetDeliveryAddressActionBuilder	builder(StagedOrderSetDeliveryAddressAction template)	create builder for StagedOrderSetDeliveryAddressAction instance
StagedOrderSetDeliveryAddressAction	copyDeep()
static StagedOrderSetDeliveryAddressAction	deepCopy(StagedOrderSetDeliveryAddressAction template)	factory method to create a deep copy of StagedOrderSetDeliveryAddressAction
@Valid BaseAddress	getAddress()	Value to set.
String	getDeliveryId()	id of an existing Delivery.
String	getDeliveryKey()	key of an existing Delivery.
static StagedOrderSetDeliveryAddressAction	of()	factory method
static StagedOrderSetDeliveryAddressAction	of(StagedOrderSetDeliveryAddressAction template)	factory method to create a shallow copy StagedOrderSetDeliveryAddressAction
static StagedOrderSetDeliveryAddressAction	ofUnset()
void	setAddress(BaseAddress address)	Value to set.
void	setDeliveryId(String deliveryId)	id of an existing Delivery.
void	setDeliveryKey(String deliveryKey)	key of an existing Delivery.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetDeliveryAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetDeliveryAddressAction(Function<StagedOrderSetDeliveryAddressAction,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

SET_DELIVERY_ADDRESS

static final String SET_DELIVERY_ADDRESS

discriminator value for StagedOrderSetDeliveryAddressAction

See Also:

• Constant Field Values

Method Details

getDeliveryId

String getDeliveryId()

id of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Returns:

deliveryId

getDeliveryKey

String getDeliveryKey()

key of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Returns:

deliveryKey

getAddress

@Valid
@Valid BaseAddress getAddress()

Value to set. If empty, any existing value will be removed.

Returns:

address

setDeliveryId

void setDeliveryId(String deliveryId)

id of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Parameters:

deliveryId - value to be set

setDeliveryKey

void setDeliveryKey(String deliveryKey)

key of an existing Delivery.

Either deliveryId or deliveryKey must be provided.

Parameters:

deliveryKey - value to be set

setAddress

void setAddress(BaseAddress address)

Value to set. If empty, any existing value will be removed.

Parameters:

address - value to be set

of

static StagedOrderSetDeliveryAddressAction of()

factory method

Returns:

instance of StagedOrderSetDeliveryAddressAction

of

static StagedOrderSetDeliveryAddressAction of(StagedOrderSetDeliveryAddressAction template)

factory method to create a shallow copy StagedOrderSetDeliveryAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetDeliveryAddressAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetDeliveryAddressAction deepCopy(@Nullable
 StagedOrderSetDeliveryAddressAction template)

factory method to create a deep copy of StagedOrderSetDeliveryAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetDeliveryAddressActionBuilder builder()

builder factory method for StagedOrderSetDeliveryAddressAction

Returns:

builder

builder

static StagedOrderSetDeliveryAddressActionBuilder builder(StagedOrderSetDeliveryAddressAction template)

create builder for StagedOrderSetDeliveryAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetDeliveryAddressAction

default <T> T withStagedOrderSetDeliveryAddressAction(Function<StagedOrderSetDeliveryAddressAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetDeliveryAddressAction ofUnset()

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference