Package com.commercetools.api.models.order_edit

Interface StagedOrderSetReturnItemCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetReturnItemCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetReturnItemCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetReturnItemCustomFieldAction stagedOrderSetReturnItemCustomFieldAction = StagedOrderSetReturnItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

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

static final String SET_RETURN_ITEM_CUSTOM_FIELD

discriminator value for StagedOrderSetReturnItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getReturnItemId

String getReturnItemId()

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemId

getReturnItemKey

String getReturnItemKey()

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemKey

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)

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemId - value to be set

setReturnItemKey

void setReturnItemKey(String returnItemKey)

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemKey - 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 StagedOrderSetReturnItemCustomFieldAction of()

factory method

Returns:

instance of StagedOrderSetReturnItemCustomFieldAction

of

static StagedOrderSetReturnItemCustomFieldAction of(StagedOrderSetReturnItemCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetReturnItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetReturnItemCustomFieldAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetReturnItemCustomFieldAction deepCopy(@Nullable
 StagedOrderSetReturnItemCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetReturnItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetReturnItemCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetReturnItemCustomFieldAction

Returns:

builder

builder

static StagedOrderSetReturnItemCustomFieldActionBuilder builder(StagedOrderSetReturnItemCustomFieldAction template)

create builder for StagedOrderSetReturnItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetReturnItemCustomFieldAction

default <T> T withStagedOrderSetReturnItemCustomFieldAction(Function<StagedOrderSetReturnItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetReturnItemCustomFieldAction ofUnset(String name,
 String returnItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference