Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetTextLineItemCustomFieldAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

public interface ShoppingListSetTextLineItemCustomFieldAction
extends ShoppingListUpdateAction

ShoppingListSetTextLineItemCustomFieldAction Example to create an instance using the builder pattern

     ShoppingListSetTextLineItemCustomFieldAction shoppingListSetTextLineItemCustomFieldAction = ShoppingListSetTextLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_TEXT_LINE_ITEM_CUSTOM_FIELD	discriminator value for ShoppingListSetTextLineItemCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListSetTextLineItemCustomFieldActionBuilder	builder()	builder factory method for ShoppingListSetTextLineItemCustomFieldAction
static ShoppingListSetTextLineItemCustomFieldActionBuilder	builder(ShoppingListSetTextLineItemCustomFieldAction template)	create builder for ShoppingListSetTextLineItemCustomFieldAction instance
ShoppingListSetTextLineItemCustomFieldAction	copyDeep()
static ShoppingListSetTextLineItemCustomFieldAction	deepCopy(ShoppingListSetTextLineItemCustomFieldAction template)	factory method to create a deep copy of ShoppingListSetTextLineItemCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
String	getTextLineItemId()	The id of the TextLineItem to update.
String	getTextLineItemKey()	The key of the TextLineItem to update.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static ShoppingListSetTextLineItemCustomFieldAction	of()	factory method
static ShoppingListSetTextLineItemCustomFieldAction	of(ShoppingListSetTextLineItemCustomFieldAction template)	factory method to create a shallow copy ShoppingListSetTextLineItemCustomFieldAction
static ShoppingListSetTextLineItemCustomFieldAction	ofUnset(String name, String textLineItemId)
void	setName(String name)	Name of the Custom Field.
void	setTextLineItemId(String textLineItemId)	The id of the TextLineItem to update.
void	setTextLineItemKey(String textLineItemKey)	The key of the TextLineItem 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<ShoppingListSetTextLineItemCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListSetTextLineItemCustomFieldAction(Function<ShoppingListSetTextLineItemCustomFieldAction,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_TEXT_LINE_ITEM_CUSTOM_FIELD

static final String SET_TEXT_LINE_ITEM_CUSTOM_FIELD

discriminator value for ShoppingListSetTextLineItemCustomFieldAction

See Also:

• Constant Field Values

Method Details

getTextLineItemId

String getTextLineItemId()

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

Returns:

textLineItemId

getTextLineItemKey

String getTextLineItemKey()

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

Returns:

textLineItemKey

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

setTextLineItemId

void setTextLineItemId(String textLineItemId)

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

Parameters:

textLineItemId - value to be set

setTextLineItemKey

void setTextLineItemKey(String textLineItemKey)

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

Parameters:

textLineItemKey - 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 ShoppingListSetTextLineItemCustomFieldAction of()

factory method

Returns:

instance of ShoppingListSetTextLineItemCustomFieldAction

of

static ShoppingListSetTextLineItemCustomFieldAction of(ShoppingListSetTextLineItemCustomFieldAction template)

factory method to create a shallow copy ShoppingListSetTextLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShoppingListSetTextLineItemCustomFieldAction copyDeep()

Specified by:

copyDeep in interface ShoppingListUpdateAction

deepCopy

@Nullable
static ShoppingListSetTextLineItemCustomFieldAction deepCopy(@Nullable
 ShoppingListSetTextLineItemCustomFieldAction template)

factory method to create a deep copy of ShoppingListSetTextLineItemCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetTextLineItemCustomFieldActionBuilder builder()

builder factory method for ShoppingListSetTextLineItemCustomFieldAction

Returns:

builder

builder

static ShoppingListSetTextLineItemCustomFieldActionBuilder builder(ShoppingListSetTextLineItemCustomFieldAction template)

create builder for ShoppingListSetTextLineItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetTextLineItemCustomFieldAction

default <T> T withShoppingListSetTextLineItemCustomFieldAction(Function<ShoppingListSetTextLineItemCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static ShoppingListSetTextLineItemCustomFieldAction ofUnset(String name,
 String textLineItemId)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference