Package com.commercetools.api.models.order

Interface OrderSetShippingAddressCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetShippingAddressCustomFieldAction
extends OrderUpdateAction

OrderSetShippingAddressCustomFieldAction Example to create an instance using the builder pattern

     OrderSetShippingAddressCustomFieldAction orderSetShippingAddressCustomFieldAction = OrderSetShippingAddressCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

static final String SET_SHIPPING_ADDRESS_CUSTOM_FIELD

discriminator value for OrderSetShippingAddressCustomFieldAction

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

factory method

Returns:

instance of OrderSetShippingAddressCustomFieldAction

of

static OrderSetShippingAddressCustomFieldAction of(OrderSetShippingAddressCustomFieldAction template)

factory method to create a shallow copy OrderSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderSetShippingAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderSetShippingAddressCustomFieldAction deepCopy(@Nullable
 OrderSetShippingAddressCustomFieldAction template)

factory method to create a deep copy of OrderSetShippingAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetShippingAddressCustomFieldActionBuilder builder()

builder factory method for OrderSetShippingAddressCustomFieldAction

Returns:

builder

builder

static OrderSetShippingAddressCustomFieldActionBuilder builder(OrderSetShippingAddressCustomFieldAction template)

create builder for OrderSetShippingAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetShippingAddressCustomFieldAction

default <T> T withOrderSetShippingAddressCustomFieldAction(Function<OrderSetShippingAddressCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetShippingAddressCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference