Package com.commercetools.api.models.order

Interface OrderSetReturnItemCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderSetReturnItemCustomFieldActionImpl

public interface OrderSetReturnItemCustomFieldAction
extends OrderUpdateAction

OrderSetReturnItemCustomFieldAction Example to create an instance using the builder pattern

     OrderSetReturnItemCustomFieldAction orderSetReturnItemCustomFieldAction = OrderSetReturnItemCustomFieldAction.builder()
             .returnItemId("{returnItemId}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_RETURN_ITEM_CUSTOM_FIELD	discriminator value for OrderSetReturnItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static OrderSetReturnItemCustomFieldActionBuilder	builder()	builder factory method for OrderSetReturnItemCustomFieldAction
static OrderSetReturnItemCustomFieldActionBuilder	builder(OrderSetReturnItemCustomFieldAction template)	create builder for OrderSetReturnItemCustomFieldAction instance
static OrderSetReturnItemCustomFieldAction	deepCopy(OrderSetReturnItemCustomFieldAction template)	factory method to create a deep copy of OrderSetReturnItemCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
@NotNull String	getReturnItemId()
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static OrderSetReturnItemCustomFieldAction	of()	factory method
static OrderSetReturnItemCustomFieldAction	of(OrderSetReturnItemCustomFieldAction template)	factory method to create a shallow copy OrderSetReturnItemCustomFieldAction
static OrderSetReturnItemCustomFieldAction	ofUnset(String name, String returnItemId)
void	setName(String name)	Name of the Custom Field.
void	setReturnItemId(String returnItemId)	set returnItemId
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<OrderSetReturnItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetReturnItemCustomFieldAction(Function<OrderSetReturnItemCustomFieldAction,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_RETURN_ITEM_CUSTOM_FIELD

static final String SET_RETURN_ITEM_CUSTOM_FIELD

discriminator value for OrderSetReturnItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getReturnItemId

@NotNull
@NotNull String getReturnItemId()

Returns:

returnItemId

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

setReturnItemId

void setReturnItemId(String returnItemId)

set returnItemId

Parameters:

returnItemId - value to be set

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

factory method

Returns:

instance of OrderSetReturnItemCustomFieldAction

of

static OrderSetReturnItemCustomFieldAction of(OrderSetReturnItemCustomFieldAction template)

factory method to create a shallow copy OrderSetReturnItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderSetReturnItemCustomFieldAction deepCopy(@Nullable
 OrderSetReturnItemCustomFieldAction template)

factory method to create a deep copy of OrderSetReturnItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetReturnItemCustomFieldActionBuilder builder()

builder factory method for OrderSetReturnItemCustomFieldAction

Returns:

builder

builder

static OrderSetReturnItemCustomFieldActionBuilder builder(OrderSetReturnItemCustomFieldAction template)

create builder for OrderSetReturnItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetReturnItemCustomFieldAction

default <T> T withOrderSetReturnItemCustomFieldAction(Function<OrderSetReturnItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetReturnItemCustomFieldAction ofUnset(String name,
 String returnItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference