Package com.commercetools.api.models.shopping_list

Interface ShoppingListSetTextLineItemDescriptionAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

public interface ShoppingListSetTextLineItemDescriptionAction
extends ShoppingListUpdateAction

ShoppingListSetTextLineItemDescriptionAction Example to create an instance using the builder pattern

     ShoppingListSetTextLineItemDescriptionAction shoppingListSetTextLineItemDescriptionAction = ShoppingListSetTextLineItemDescriptionAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_TEXT_LINE_ITEM_DESCRIPTION	discriminator value for ShoppingListSetTextLineItemDescriptionAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListSetTextLineItemDescriptionActionBuilder	builder()	builder factory method for ShoppingListSetTextLineItemDescriptionAction
static ShoppingListSetTextLineItemDescriptionActionBuilder	builder(ShoppingListSetTextLineItemDescriptionAction template)	create builder for ShoppingListSetTextLineItemDescriptionAction instance
ShoppingListSetTextLineItemDescriptionAction	copyDeep()
static ShoppingListSetTextLineItemDescriptionAction	deepCopy(ShoppingListSetTextLineItemDescriptionAction template)	factory method to create a deep copy of ShoppingListSetTextLineItemDescriptionAction
@Valid LocalizedString	getDescription()	Value to set.
String	getTextLineItemId()	The id of the TextLineItem to update.
String	getTextLineItemKey()	The key of the TextLineItem to update.
static ShoppingListSetTextLineItemDescriptionAction	of()	factory method
static ShoppingListSetTextLineItemDescriptionAction	of(ShoppingListSetTextLineItemDescriptionAction template)	factory method to create a shallow copy ShoppingListSetTextLineItemDescriptionAction
void	setDescription(LocalizedString description)	Value to set.
void	setTextLineItemId(String textLineItemId)	The id of the TextLineItem to update.
void	setTextLineItemKey(String textLineItemKey)	The key of the TextLineItem to update.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListSetTextLineItemDescriptionAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListSetTextLineItemDescriptionAction(Function<ShoppingListSetTextLineItemDescriptionAction,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_DESCRIPTION

static final String SET_TEXT_LINE_ITEM_DESCRIPTION

discriminator value for ShoppingListSetTextLineItemDescriptionAction

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

getDescription

@Valid
@Valid LocalizedString getDescription()

Value to set. If empty, any existing value will be removed.

Returns:

description

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

setDescription

void setDescription(LocalizedString description)

Value to set. If empty, any existing value will be removed.

Parameters:

description - value to be set

of

static ShoppingListSetTextLineItemDescriptionAction of()

factory method

Returns:

instance of ShoppingListSetTextLineItemDescriptionAction

of

static ShoppingListSetTextLineItemDescriptionAction of(ShoppingListSetTextLineItemDescriptionAction template)

factory method to create a shallow copy ShoppingListSetTextLineItemDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShoppingListSetTextLineItemDescriptionAction copyDeep()

Specified by:

copyDeep in interface ShoppingListUpdateAction

deepCopy

@Nullable
static ShoppingListSetTextLineItemDescriptionAction deepCopy(@Nullable
 ShoppingListSetTextLineItemDescriptionAction template)

factory method to create a deep copy of ShoppingListSetTextLineItemDescriptionAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListSetTextLineItemDescriptionActionBuilder builder()

builder factory method for ShoppingListSetTextLineItemDescriptionAction

Returns:

builder

builder

static ShoppingListSetTextLineItemDescriptionActionBuilder builder(ShoppingListSetTextLineItemDescriptionAction template)

create builder for ShoppingListSetTextLineItemDescriptionAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListSetTextLineItemDescriptionAction

default <T> T withShoppingListSetTextLineItemDescriptionAction(Function<ShoppingListSetTextLineItemDescriptionAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference