Package com.commercetools.api.models.order

Interface OrderSetDeliveryCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderSetDeliveryCustomFieldActionImpl

public interface OrderSetDeliveryCustomFieldAction
extends OrderUpdateAction

OrderSetDeliveryCustomFieldAction Example to create an instance using the builder pattern

     OrderSetDeliveryCustomFieldAction orderSetDeliveryCustomFieldAction = OrderSetDeliveryCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_CUSTOM_FIELD	discriminator value for OrderSetDeliveryCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static OrderSetDeliveryCustomFieldActionBuilder	builder()	builder factory method for OrderSetDeliveryCustomFieldAction
static OrderSetDeliveryCustomFieldActionBuilder	builder(OrderSetDeliveryCustomFieldAction template)	create builder for OrderSetDeliveryCustomFieldAction instance
static OrderSetDeliveryCustomFieldAction	deepCopy(OrderSetDeliveryCustomFieldAction template)	factory method to create a deep copy of OrderSetDeliveryCustomFieldAction
String	getDeliveryId()	Either deliveryId or deliveryKey is required for this update action.
String	getDeliveryKey()	Either deliveryId or deliveryKey is required for this update action.
@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 OrderSetDeliveryCustomFieldAction	of()	factory method
static OrderSetDeliveryCustomFieldAction	of(OrderSetDeliveryCustomFieldAction template)	factory method to create a shallow copy OrderSetDeliveryCustomFieldAction
static OrderSetDeliveryCustomFieldAction	ofUnset(String name, String deliveryId)
void	setDeliveryId(String deliveryId)	Either deliveryId or deliveryKey is required for this update action.
void	setDeliveryKey(String deliveryKey)	Either deliveryId or deliveryKey is required for this update action.
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<OrderSetDeliveryCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetDeliveryCustomFieldAction(Function<OrderSetDeliveryCustomFieldAction,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_CUSTOM_FIELD

static final String SET_DELIVERY_CUSTOM_FIELD

discriminator value for OrderSetDeliveryCustomFieldAction

See Also:

• Constant Field Values

Method Details

getDeliveryId

String getDeliveryId()

Either deliveryId or deliveryKey is required for this update action.

Returns:

deliveryId

getDeliveryKey

String getDeliveryKey()

Either deliveryId or deliveryKey is required for this update action.

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)

Either deliveryId or deliveryKey is required for this update action.

Parameters:

deliveryId - value to be set

setDeliveryKey

void setDeliveryKey(String deliveryKey)

Either deliveryId or deliveryKey is required for this update action.

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

factory method

Returns:

instance of OrderSetDeliveryCustomFieldAction

of

static OrderSetDeliveryCustomFieldAction of(OrderSetDeliveryCustomFieldAction template)

factory method to create a shallow copy OrderSetDeliveryCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderSetDeliveryCustomFieldAction deepCopy(@Nullable
 OrderSetDeliveryCustomFieldAction template)

factory method to create a deep copy of OrderSetDeliveryCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetDeliveryCustomFieldActionBuilder builder()

builder factory method for OrderSetDeliveryCustomFieldAction

Returns:

builder

builder

static OrderSetDeliveryCustomFieldActionBuilder builder(OrderSetDeliveryCustomFieldAction template)

create builder for OrderSetDeliveryCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetDeliveryCustomFieldAction

default <T> T withOrderSetDeliveryCustomFieldAction(Function<OrderSetDeliveryCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetDeliveryCustomFieldAction ofUnset(String name,
 String deliveryId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference