Package com.commercetools.api.models.shopping_list

Interface ShoppingListAddTextLineItemAction

All Superinterfaces:

CustomizableDraft<ShoppingListAddTextLineItemAction>, ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

public interface ShoppingListAddTextLineItemAction
extends ShoppingListUpdateAction, CustomizableDraft<ShoppingListAddTextLineItemAction>

ShoppingListAddTextLineItemAction Example to create an instance using the builder pattern

     ShoppingListAddTextLineItemAction shoppingListAddTextLineItemAction = ShoppingListAddTextLineItemAction.builder()
             .name(nameBuilder -> nameBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_TEXT_LINE_ITEM	discriminator value for ShoppingListAddTextLineItemAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListAddTextLineItemActionBuilder	builder()	builder factory method for ShoppingListAddTextLineItemAction
static ShoppingListAddTextLineItemActionBuilder	builder(ShoppingListAddTextLineItemAction template)	create builder for ShoppingListAddTextLineItemAction instance
ShoppingListAddTextLineItemAction	copyDeep()
static ShoppingListAddTextLineItemAction	deepCopy(ShoppingListAddTextLineItemAction template)	factory method to create a deep copy of ShoppingListAddTextLineItemAction
ZonedDateTime	getAddedAt()	Date and time the TextLineItem is added to the ShoppingList.
@Valid CustomFieldsDraft	getCustom()	Custom Fields defined for the TextLineItem.
@Valid LocalizedString	getDescription()	Description of the TextLineItem.
String	getKey()	User-defined identifier of the TextLineItem.
@NotNull @Valid LocalizedString	getName()	Name of the TextLineItem.
Long	getQuantity()	Number of entries in the TextLineItem.
static ShoppingListAddTextLineItemAction	of()	factory method
static ShoppingListAddTextLineItemAction	of(ShoppingListAddTextLineItemAction template)	factory method to create a shallow copy ShoppingListAddTextLineItemAction
void	setAddedAt(ZonedDateTime addedAt)	Date and time the TextLineItem is added to the ShoppingList.
void	setCustom(CustomFieldsDraft custom)	Custom Fields defined for the TextLineItem.
void	setDescription(LocalizedString description)	Description of the TextLineItem.
void	setKey(String key)	User-defined identifier of the TextLineItem.
void	setName(LocalizedString name)	Name of the TextLineItem.
void	setQuantity(Long quantity)	Number of entries in the TextLineItem.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListAddTextLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListAddTextLineItemAction(Function<ShoppingListAddTextLineItemAction,T> helper)	accessor map function

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

unwrapCustomizableDraft

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

ADD_TEXT_LINE_ITEM

static final String ADD_TEXT_LINE_ITEM

discriminator value for ShoppingListAddTextLineItemAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@Valid
@NotNull @Valid LocalizedString getName()

Name of the TextLineItem.

Returns:

name

getKey

String getKey()

User-defined identifier of the TextLineItem. Must be unique per ShoppingList.

Returns:

key

getDescription

@Valid
@Valid LocalizedString getDescription()

Description of the TextLineItem.

Returns:

description

getQuantity

Long getQuantity()

Number of entries in the TextLineItem.

Returns:

quantity

getAddedAt

ZonedDateTime getAddedAt()

Date and time the TextLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

Returns:

addedAt

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields defined for the TextLineItem.

Specified by:

getCustom in interface CustomizableDraft<ShoppingListAddTextLineItemAction>

Returns:

custom

setName

void setName(LocalizedString name)

Name of the TextLineItem.

Parameters:

name - value to be set

setKey

void setKey(String key)

User-defined identifier of the TextLineItem. Must be unique per ShoppingList.

Parameters:

key - value to be set

setDescription

void setDescription(LocalizedString description)

Description of the TextLineItem.

Parameters:

description - value to be set

setQuantity

void setQuantity(Long quantity)

Number of entries in the TextLineItem.

Parameters:

quantity - value to be set

setAddedAt

void setAddedAt(ZonedDateTime addedAt)

Date and time the TextLineItem is added to the ShoppingList. If not set, the current date and time (UTC) is used.

Parameters:

addedAt - value to be set

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields defined for the TextLineItem.

Specified by:

setCustom in interface CustomizableDraft<ShoppingListAddTextLineItemAction>

Parameters:

custom - value to be set

of

static ShoppingListAddTextLineItemAction of()

factory method

Returns:

instance of ShoppingListAddTextLineItemAction

of

static ShoppingListAddTextLineItemAction of(ShoppingListAddTextLineItemAction template)

factory method to create a shallow copy ShoppingListAddTextLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShoppingListAddTextLineItemAction copyDeep()

Specified by:

copyDeep in interface ShoppingListUpdateAction

deepCopy

@Nullable
static ShoppingListAddTextLineItemAction deepCopy(@Nullable
 ShoppingListAddTextLineItemAction template)

factory method to create a deep copy of ShoppingListAddTextLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShoppingListAddTextLineItemActionBuilder builder()

builder factory method for ShoppingListAddTextLineItemAction

Returns:

builder

builder

static ShoppingListAddTextLineItemActionBuilder builder(ShoppingListAddTextLineItemAction template)

create builder for ShoppingListAddTextLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShoppingListAddTextLineItemAction

default <T> T withShoppingListAddTextLineItemAction(Function<ShoppingListAddTextLineItemAction,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<ShoppingListAddTextLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference