Package com.commercetools.api.models.order_edit

Interface StagedOrderSetItemShippingAddressCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetItemShippingAddressCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetItemShippingAddressCustomFieldAction stagedOrderSetItemShippingAddressCustomFieldAction = StagedOrderSetItemShippingAddressCustomFieldAction.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 StagedOrderSetItemShippingAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetItemShippingAddressCustomFieldActionBuilder	builder()	builder factory method for StagedOrderSetItemShippingAddressCustomFieldAction
static StagedOrderSetItemShippingAddressCustomFieldActionBuilder	builder(StagedOrderSetItemShippingAddressCustomFieldAction template)	create builder for StagedOrderSetItemShippingAddressCustomFieldAction instance
static StagedOrderSetItemShippingAddressCustomFieldAction	deepCopy(StagedOrderSetItemShippingAddressCustomFieldAction template)	factory method to create a deep copy of StagedOrderSetItemShippingAddressCustomFieldAction
@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 StagedOrderSetItemShippingAddressCustomFieldAction	of()	factory method
static StagedOrderSetItemShippingAddressCustomFieldAction	of(StagedOrderSetItemShippingAddressCustomFieldAction template)	factory method to create a shallow copy StagedOrderSetItemShippingAddressCustomFieldAction
static StagedOrderSetItemShippingAddressCustomFieldAction	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<StagedOrderSetItemShippingAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetItemShippingAddressCustomFieldAction(Function<StagedOrderSetItemShippingAddressCustomFieldAction,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_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

static final String SET_ITEM_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for StagedOrderSetItemShippingAddressCustomFieldAction

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

factory method

Returns:

instance of StagedOrderSetItemShippingAddressCustomFieldAction

of

static StagedOrderSetItemShippingAddressCustomFieldAction of(StagedOrderSetItemShippingAddressCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetItemShippingAddressCustomFieldAction deepCopy(@Nullable
 StagedOrderSetItemShippingAddressCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetItemShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetItemShippingAddressCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetItemShippingAddressCustomFieldAction

Returns:

builder

builder

static StagedOrderSetItemShippingAddressCustomFieldActionBuilder builder(StagedOrderSetItemShippingAddressCustomFieldAction template)

create builder for StagedOrderSetItemShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetItemShippingAddressCustomFieldAction

default <T> T withStagedOrderSetItemShippingAddressCustomFieldAction(Function<StagedOrderSetItemShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetItemShippingAddressCustomFieldAction ofUnset(String name,
 String addressKey)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference