Package com.commercetools.api.models.order_edit

Interface StagedOrderSetDeliveryAddressCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetDeliveryAddressCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetDeliveryAddressCustomFieldAction stagedOrderSetDeliveryAddressCustomFieldAction = StagedOrderSetDeliveryAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_ADDRESS_CUSTOM_FIELD	discriminator value for StagedOrderSetDeliveryAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetDeliveryAddressCustomFieldActionBuilder	builder()	builder factory method for StagedOrderSetDeliveryAddressCustomFieldAction
static StagedOrderSetDeliveryAddressCustomFieldActionBuilder	builder(StagedOrderSetDeliveryAddressCustomFieldAction template)	create builder for StagedOrderSetDeliveryAddressCustomFieldAction instance
StagedOrderSetDeliveryAddressCustomFieldAction	copyDeep()
static StagedOrderSetDeliveryAddressCustomFieldAction	deepCopy(StagedOrderSetDeliveryAddressCustomFieldAction template)	factory method to create a deep copy of StagedOrderSetDeliveryAddressCustomFieldAction
String	getDeliveryId()	id of an existing Delivery.
String	getDeliveryKey()	key of an existing Delivery.
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static StagedOrderSetDeliveryAddressCustomFieldAction	of()	factory method
static StagedOrderSetDeliveryAddressCustomFieldAction	of(StagedOrderSetDeliveryAddressCustomFieldAction template)	factory method to create a shallow copy StagedOrderSetDeliveryAddressCustomFieldAction
static StagedOrderSetDeliveryAddressCustomFieldAction	ofUnset(String name, String deliveryId)
void	setDeliveryId(String deliveryId)	id of an existing Delivery.
void	setDeliveryKey(String deliveryKey)	key of an existing Delivery.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetDeliveryAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetDeliveryAddressCustomFieldAction(Function<StagedOrderSetDeliveryAddressCustomFieldAction,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_CUSTOM_FIELD

static final String SET_DELIVERY_ADDRESS_CUSTOM_FIELD

discriminator value for StagedOrderSetDeliveryAddressCustomFieldAction

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

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

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

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static StagedOrderSetDeliveryAddressCustomFieldAction of()

factory method

Returns:

instance of StagedOrderSetDeliveryAddressCustomFieldAction

of

static StagedOrderSetDeliveryAddressCustomFieldAction of(StagedOrderSetDeliveryAddressCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetDeliveryAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetDeliveryAddressCustomFieldAction deepCopy(@Nullable
 StagedOrderSetDeliveryAddressCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetDeliveryAddressCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetDeliveryAddressCustomFieldAction

Returns:

builder

builder

static StagedOrderSetDeliveryAddressCustomFieldActionBuilder builder(StagedOrderSetDeliveryAddressCustomFieldAction template)

create builder for StagedOrderSetDeliveryAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetDeliveryAddressCustomFieldAction

default <T> T withStagedOrderSetDeliveryAddressCustomFieldAction(Function<StagedOrderSetDeliveryAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetDeliveryAddressCustomFieldAction ofUnset(String name,
 String deliveryId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference