Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetCustomFieldActionImpl

public interface StagedOrderSetCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetCustomFieldAction stagedOrderSetCustomFieldAction = StagedOrderSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

static final String SET_CUSTOM_FIELD

discriminator value for StagedOrderSetCustomFieldAction

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

factory method

Returns:

instance of StagedOrderSetCustomFieldAction

of

static StagedOrderSetCustomFieldAction of(StagedOrderSetCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetCustomFieldAction deepCopy(@Nullable
 StagedOrderSetCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetCustomFieldAction

Returns:

builder

builder

static StagedOrderSetCustomFieldActionBuilder builder(StagedOrderSetCustomFieldAction template)

create builder for StagedOrderSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetCustomFieldAction

default <T> T withStagedOrderSetCustomFieldAction(Function<StagedOrderSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference