Package com.commercetools.api.models.order

Interface OrderSetCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderSetCustomFieldActionImpl

public interface OrderSetCustomFieldAction
extends OrderUpdateAction

OrderSetCustomFieldAction Example to create an instance using the builder pattern

     OrderSetCustomFieldAction orderSetCustomFieldAction = OrderSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_FIELD	discriminator value for OrderSetCustomFieldAction

Method Summary

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

static final String SET_CUSTOM_FIELD

discriminator value for OrderSetCustomFieldAction

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

factory method

Returns:

instance of OrderSetCustomFieldAction

of

static OrderSetCustomFieldAction of(OrderSetCustomFieldAction template)

factory method to create a shallow copy OrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderSetCustomFieldAction deepCopy(@Nullable
 OrderSetCustomFieldAction template)

factory method to create a deep copy of OrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetCustomFieldActionBuilder builder()

builder factory method for OrderSetCustomFieldAction

Returns:

builder

builder

static OrderSetCustomFieldActionBuilder builder(OrderSetCustomFieldAction template)

create builder for OrderSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetCustomFieldAction

default <T> T withOrderSetCustomFieldAction(Function<OrderSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference