Package com.commercetools.api.models.order

Interface OrderSetDeliveryAddressCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetDeliveryAddressCustomFieldAction
extends OrderUpdateAction

OrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder pattern

     OrderSetDeliveryAddressCustomFieldAction orderSetDeliveryAddressCustomFieldAction = OrderSetDeliveryAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderSetDeliveryAddressCustomFieldActionBuilder	builder()	builder factory method for OrderSetDeliveryAddressCustomFieldAction
static OrderSetDeliveryAddressCustomFieldActionBuilder	builder(OrderSetDeliveryAddressCustomFieldAction template)	create builder for OrderSetDeliveryAddressCustomFieldAction instance
OrderSetDeliveryAddressCustomFieldAction	copyDeep()
static OrderSetDeliveryAddressCustomFieldAction	deepCopy(OrderSetDeliveryAddressCustomFieldAction template)	factory method to create a deep copy of OrderSetDeliveryAddressCustomFieldAction
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 OrderSetDeliveryAddressCustomFieldAction	of()	factory method
static OrderSetDeliveryAddressCustomFieldAction	of(OrderSetDeliveryAddressCustomFieldAction template)	factory method to create a shallow copy OrderSetDeliveryAddressCustomFieldAction
static OrderSetDeliveryAddressCustomFieldAction	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<OrderSetDeliveryAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetDeliveryAddressCustomFieldAction(Function<OrderSetDeliveryAddressCustomFieldAction,T> helper)	accessor map function

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

getAction, withOrderUpdateAction

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

get

Field Details

SET_DELIVERY_ADDRESS_CUSTOM_FIELD

static final String SET_DELIVERY_ADDRESS_CUSTOM_FIELD

discriminator value for OrderSetDeliveryAddressCustomFieldAction

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

factory method

Returns:

instance of OrderSetDeliveryAddressCustomFieldAction

of

static OrderSetDeliveryAddressCustomFieldAction of(OrderSetDeliveryAddressCustomFieldAction template)

factory method to create a shallow copy OrderSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderSetDeliveryAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderSetDeliveryAddressCustomFieldAction deepCopy(@Nullable
 OrderSetDeliveryAddressCustomFieldAction template)

factory method to create a deep copy of OrderSetDeliveryAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetDeliveryAddressCustomFieldActionBuilder builder()

builder factory method for OrderSetDeliveryAddressCustomFieldAction

Returns:

builder

builder

static OrderSetDeliveryAddressCustomFieldActionBuilder builder(OrderSetDeliveryAddressCustomFieldAction template)

create builder for OrderSetDeliveryAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetDeliveryAddressCustomFieldAction

default <T> T withOrderSetDeliveryAddressCustomFieldAction(Function<OrderSetDeliveryAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetDeliveryAddressCustomFieldAction ofUnset(String name,
 String deliveryId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference