Package com.commercetools.api.models.order_edit

Interface OrderEditSetCustomFieldAction

All Superinterfaces:

OrderEditUpdateAction, ResourceUpdateAction<OrderEditUpdateAction>

All Known Implementing Classes:

OrderEditSetCustomFieldActionImpl

public interface OrderEditSetCustomFieldAction
extends OrderEditUpdateAction

OrderEditSetCustomFieldAction Example to create an instance using the builder pattern

     OrderEditSetCustomFieldAction orderEditSetCustomFieldAction = OrderEditSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderEditSetCustomFieldActionBuilder	builder()	builder factory method for OrderEditSetCustomFieldAction
static OrderEditSetCustomFieldActionBuilder	builder(OrderEditSetCustomFieldAction template)	create builder for OrderEditSetCustomFieldAction instance
static OrderEditSetCustomFieldAction	deepCopy(OrderEditSetCustomFieldAction template)	factory method to create a deep copy of OrderEditSetCustomFieldAction
@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 OrderEditSetCustomFieldAction	of()	factory method
static OrderEditSetCustomFieldAction	of(OrderEditSetCustomFieldAction template)	factory method to create a shallow copy OrderEditSetCustomFieldAction
static OrderEditSetCustomFieldAction	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<OrderEditSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderEditSetCustomFieldAction(Function<OrderEditSetCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order_edit.OrderEditUpdateAction

getAction, withOrderEditUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

SET_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for OrderEditSetCustomFieldAction

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

factory method

Returns:

instance of OrderEditSetCustomFieldAction

of

static OrderEditSetCustomFieldAction of(OrderEditSetCustomFieldAction template)

factory method to create a shallow copy OrderEditSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderEditSetCustomFieldAction deepCopy(@Nullable
 OrderEditSetCustomFieldAction template)

factory method to create a deep copy of OrderEditSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderEditSetCustomFieldActionBuilder builder()

builder factory method for OrderEditSetCustomFieldAction

Returns:

builder

builder

static OrderEditSetCustomFieldActionBuilder builder(OrderEditSetCustomFieldAction template)

create builder for OrderEditSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderEditSetCustomFieldAction

default <T> T withOrderEditSetCustomFieldAction(Function<OrderEditSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderEditSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference