Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingAddressCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetShippingAddressCustomFieldActionImpl

public interface StagedOrderSetShippingAddressCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetShippingAddressCustomFieldAction stagedOrderSetShippingAddressCustomFieldAction = StagedOrderSetShippingAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_CUSTOM_FIELD	discriminator value for StagedOrderSetShippingAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingAddressCustomFieldActionBuilder	builder()	builder factory method for StagedOrderSetShippingAddressCustomFieldAction
static StagedOrderSetShippingAddressCustomFieldActionBuilder	builder(StagedOrderSetShippingAddressCustomFieldAction template)	create builder for StagedOrderSetShippingAddressCustomFieldAction instance
static StagedOrderSetShippingAddressCustomFieldAction	deepCopy(StagedOrderSetShippingAddressCustomFieldAction template)	factory method to create a deep copy of StagedOrderSetShippingAddressCustomFieldAction
@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 StagedOrderSetShippingAddressCustomFieldAction	of()	factory method
static StagedOrderSetShippingAddressCustomFieldAction	of(StagedOrderSetShippingAddressCustomFieldAction template)	factory method to create a shallow copy StagedOrderSetShippingAddressCustomFieldAction
static StagedOrderSetShippingAddressCustomFieldAction	ofUnset(String name)
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<StagedOrderSetShippingAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingAddressCustomFieldAction(Function<StagedOrderSetShippingAddressCustomFieldAction,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_SHIPPING_ADDRESS_CUSTOM_FIELD

static final String SET_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for StagedOrderSetShippingAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

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

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

factory method

Returns:

instance of StagedOrderSetShippingAddressCustomFieldAction

of

static StagedOrderSetShippingAddressCustomFieldAction of(StagedOrderSetShippingAddressCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetShippingAddressCustomFieldAction deepCopy(@Nullable
 StagedOrderSetShippingAddressCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingAddressCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetShippingAddressCustomFieldAction

Returns:

builder

builder

static StagedOrderSetShippingAddressCustomFieldActionBuilder builder(StagedOrderSetShippingAddressCustomFieldAction template)

create builder for StagedOrderSetShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingAddressCustomFieldAction

default <T> T withStagedOrderSetShippingAddressCustomFieldAction(Function<StagedOrderSetShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetShippingAddressCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference