Package com.commercetools.api.models.order

Interface OrderSetItemShippingAddressCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderSetItemShippingAddressCustomFieldActionImpl

public interface OrderSetItemShippingAddressCustomFieldAction
extends OrderUpdateAction

OrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     OrderSetItemShippingAddressCustomFieldAction orderSetItemShippingAddressCustomFieldAction = OrderSetItemShippingAddressCustomFieldAction.builder()
             .addressKey("{addressKey}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD	discriminator value for OrderSetItemShippingAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static OrderSetItemShippingAddressCustomFieldActionBuilder	builder()	builder factory method for OrderSetItemShippingAddressCustomFieldAction
static OrderSetItemShippingAddressCustomFieldActionBuilder	builder(OrderSetItemShippingAddressCustomFieldAction template)	create builder for OrderSetItemShippingAddressCustomFieldAction instance
static OrderSetItemShippingAddressCustomFieldAction	deepCopy(OrderSetItemShippingAddressCustomFieldAction template)	factory method to create a deep copy of OrderSetItemShippingAddressCustomFieldAction
@NotNull String	getAddressKey()	key of the Address in itemShippingAddresses.
@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 OrderSetItemShippingAddressCustomFieldAction	of()	factory method
static OrderSetItemShippingAddressCustomFieldAction	of(OrderSetItemShippingAddressCustomFieldAction template)	factory method to create a shallow copy OrderSetItemShippingAddressCustomFieldAction
static OrderSetItemShippingAddressCustomFieldAction	ofUnset(String name, String addressKey)
void	setAddressKey(String addressKey)	key of the Address in itemShippingAddresses.
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<OrderSetItemShippingAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetItemShippingAddressCustomFieldAction(Function<OrderSetItemShippingAddressCustomFieldAction,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_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

static final String SET_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for OrderSetItemShippingAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getAddressKey

@NotNull
@NotNull String getAddressKey()

key of the Address in itemShippingAddresses.

Returns:

addressKey

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

setAddressKey

void setAddressKey(String addressKey)

key of the Address in itemShippingAddresses.

Parameters:

addressKey - 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 OrderSetItemShippingAddressCustomFieldAction of()

factory method

Returns:

instance of OrderSetItemShippingAddressCustomFieldAction

of

static OrderSetItemShippingAddressCustomFieldAction of(OrderSetItemShippingAddressCustomFieldAction template)

factory method to create a shallow copy OrderSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderSetItemShippingAddressCustomFieldAction deepCopy(@Nullable
 OrderSetItemShippingAddressCustomFieldAction template)

factory method to create a deep copy of OrderSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetItemShippingAddressCustomFieldActionBuilder builder()

builder factory method for OrderSetItemShippingAddressCustomFieldAction

Returns:

builder

builder

static OrderSetItemShippingAddressCustomFieldActionBuilder builder(OrderSetItemShippingAddressCustomFieldAction template)

create builder for OrderSetItemShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetItemShippingAddressCustomFieldAction

default <T> T withOrderSetItemShippingAddressCustomFieldAction(Function<OrderSetItemShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetItemShippingAddressCustomFieldAction ofUnset(String name,
 String addressKey)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference