Package com.commercetools.api.models.order

Interface OrderSetLineItemCustomFieldAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderSetLineItemCustomFieldActionImpl

public interface OrderSetLineItemCustomFieldAction
extends OrderUpdateAction

OrderSetLineItemCustomFieldAction Example to create an instance using the builder pattern

     OrderSetLineItemCustomFieldAction orderSetLineItemCustomFieldAction = OrderSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_CUSTOM_FIELD	discriminator value for OrderSetLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static OrderSetLineItemCustomFieldActionBuilder	builder()	builder factory method for OrderSetLineItemCustomFieldAction
static OrderSetLineItemCustomFieldActionBuilder	builder(OrderSetLineItemCustomFieldAction template)	create builder for OrderSetLineItemCustomFieldAction instance
static OrderSetLineItemCustomFieldAction	deepCopy(OrderSetLineItemCustomFieldAction template)	factory method to create a deep copy of OrderSetLineItemCustomFieldAction
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem 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 OrderSetLineItemCustomFieldAction	of()	factory method
static OrderSetLineItemCustomFieldAction	of(OrderSetLineItemCustomFieldAction template)	factory method to create a shallow copy OrderSetLineItemCustomFieldAction
static OrderSetLineItemCustomFieldAction	ofUnset(String name, String lineItemId)
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem 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<OrderSetLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetLineItemCustomFieldAction(Function<OrderSetLineItemCustomFieldAction,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_LINE_ITEM_CUSTOM_FIELD

static final String SET_LINE_ITEM_CUSTOM_FIELD

discriminator value for OrderSetLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

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

setLineItemId

void setLineItemId(String lineItemId)

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - 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 OrderSetLineItemCustomFieldAction of()

factory method

Returns:

instance of OrderSetLineItemCustomFieldAction

of

static OrderSetLineItemCustomFieldAction of(OrderSetLineItemCustomFieldAction template)

factory method to create a shallow copy OrderSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderSetLineItemCustomFieldAction deepCopy(@Nullable
 OrderSetLineItemCustomFieldAction template)

factory method to create a deep copy of OrderSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetLineItemCustomFieldActionBuilder builder()

builder factory method for OrderSetLineItemCustomFieldAction

Returns:

builder

builder

static OrderSetLineItemCustomFieldActionBuilder builder(OrderSetLineItemCustomFieldAction template)

create builder for OrderSetLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetLineItemCustomFieldAction

default <T> T withOrderSetLineItemCustomFieldAction(Function<OrderSetLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static OrderSetLineItemCustomFieldAction ofUnset(String name,
 String lineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference