Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetLineItemCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

public interface ShoppingListSetLineItemCustomFieldAction
extends ShoppingListUpdateAction

ShoppingListSetLineItemCustomFieldAction Example to create an instance using the builder pattern

     ShoppingListSetLineItemCustomFieldAction shoppingListSetLineItemCustomFieldAction = ShoppingListSetLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ShoppingListSetLineItemCustomFieldActionBuilder	builder()	builder factory method for ShoppingListSetLineItemCustomFieldAction
static ShoppingListSetLineItemCustomFieldActionBuilder	builder(ShoppingListSetLineItemCustomFieldAction template)	create builder for ShoppingListSetLineItemCustomFieldAction instance
ShoppingListSetLineItemCustomFieldAction	copyDeep()
static ShoppingListSetLineItemCustomFieldAction	deepCopy(ShoppingListSetLineItemCustomFieldAction template)	factory method to create a deep copy of ShoppingListSetLineItemCustomFieldAction
String	getLineItemId()	The id of the ShoppingListLineItem to update.
String	getLineItemKey()	The key of the ShoppingListLineItem 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 ShoppingListSetLineItemCustomFieldAction	of()	factory method
static ShoppingListSetLineItemCustomFieldAction	of(ShoppingListSetLineItemCustomFieldAction template)	factory method to create a shallow copy ShoppingListSetLineItemCustomFieldAction
static ShoppingListSetLineItemCustomFieldAction	ofUnset(String name, String lineItemId)
void	setLineItemId(String lineItemId)	The id of the ShoppingListLineItem to update.
void	setLineItemKey(String lineItemKey)	The key of the ShoppingListLineItem 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<ShoppingListSetLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListSetLineItemCustomFieldAction(Function<ShoppingListSetLineItemCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.shopping_list.ShoppingListUpdateAction

getAction, withShoppingListUpdateAction

Field Details

SET_LINE_ITEM_CUSTOM_FIELD

static final String SET_LINE_ITEM_CUSTOM_FIELD

discriminator value for ShoppingListSetLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

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

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

The key of the ShoppingListLineItem 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)

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

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

The key of the ShoppingListLineItem 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 ShoppingListSetLineItemCustomFieldAction of()

factory method

Returns:

instance of ShoppingListSetLineItemCustomFieldAction

of

static ShoppingListSetLineItemCustomFieldAction of(ShoppingListSetLineItemCustomFieldAction template)

factory method to create a shallow copy ShoppingListSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShoppingListSetLineItemCustomFieldAction copyDeep()

Specified by:

copyDeep in interface ShoppingListUpdateAction

deepCopy

@Nullable
static ShoppingListSetLineItemCustomFieldAction deepCopy(@Nullable
 ShoppingListSetLineItemCustomFieldAction template)

factory method to create a deep copy of ShoppingListSetLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetLineItemCustomFieldActionBuilder builder()

builder factory method for ShoppingListSetLineItemCustomFieldAction

Returns:

builder

builder

static ShoppingListSetLineItemCustomFieldActionBuilder builder(ShoppingListSetLineItemCustomFieldAction template)

create builder for ShoppingListSetLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetLineItemCustomFieldAction

default <T> T withShoppingListSetLineItemCustomFieldAction(Function<ShoppingListSetLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ShoppingListSetLineItemCustomFieldAction ofUnset(String name,
 String lineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference