Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomLineItemCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetCustomLineItemCustomFieldActionImpl

public interface StagedOrderSetCustomLineItemCustomFieldAction
extends StagedOrderUpdateAction

StagedOrderSetCustomLineItemCustomFieldAction Example to create an instance using the builder pattern

     StagedOrderSetCustomLineItemCustomFieldAction stagedOrderSetCustomLineItemCustomFieldAction = StagedOrderSetCustomLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD	discriminator value for StagedOrderSetCustomLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetCustomLineItemCustomFieldActionBuilder	builder()	builder factory method for StagedOrderSetCustomLineItemCustomFieldAction
static StagedOrderSetCustomLineItemCustomFieldActionBuilder	builder(StagedOrderSetCustomLineItemCustomFieldAction template)	create builder for StagedOrderSetCustomLineItemCustomFieldAction instance
static StagedOrderSetCustomLineItemCustomFieldAction	deepCopy(StagedOrderSetCustomLineItemCustomFieldAction template)	factory method to create a deep copy of StagedOrderSetCustomLineItemCustomFieldAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
@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 StagedOrderSetCustomLineItemCustomFieldAction	of()	factory method
static StagedOrderSetCustomLineItemCustomFieldAction	of(StagedOrderSetCustomLineItemCustomFieldAction template)	factory method to create a shallow copy StagedOrderSetCustomLineItemCustomFieldAction
static StagedOrderSetCustomLineItemCustomFieldAction	ofUnset(String name, String customLineItemId)
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
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<StagedOrderSetCustomLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetCustomLineItemCustomFieldAction(Function<StagedOrderSetCustomLineItemCustomFieldAction,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_LINE_ITEM_CUSTOM_FIELD

static final String SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD

discriminator value for StagedOrderSetCustomLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

String getCustomLineItemId()

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemKey

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

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemKey - 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 StagedOrderSetCustomLineItemCustomFieldAction of()

factory method

Returns:

instance of StagedOrderSetCustomLineItemCustomFieldAction

of

static StagedOrderSetCustomLineItemCustomFieldAction of(StagedOrderSetCustomLineItemCustomFieldAction template)

factory method to create a shallow copy StagedOrderSetCustomLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetCustomLineItemCustomFieldAction deepCopy(@Nullable
 StagedOrderSetCustomLineItemCustomFieldAction template)

factory method to create a deep copy of StagedOrderSetCustomLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetCustomLineItemCustomFieldActionBuilder builder()

builder factory method for StagedOrderSetCustomLineItemCustomFieldAction

Returns:

builder

builder

static StagedOrderSetCustomLineItemCustomFieldActionBuilder builder(StagedOrderSetCustomLineItemCustomFieldAction template)

create builder for StagedOrderSetCustomLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetCustomLineItemCustomFieldAction

default <T> T withStagedOrderSetCustomLineItemCustomFieldAction(Function<StagedOrderSetCustomLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static StagedOrderSetCustomLineItemCustomFieldAction ofUnset(String name,
 String customLineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference