Package com.commercetools.api.models.cart

Interface CartSetLineItemRecurrenceInfoAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartSetLineItemRecurrenceInfoAction
extends CartUpdateAction

Sets the recurrence information on the LineItem. If the Cart is already associated with a Recurring Order, this action will fail.

Example to create an instance using the builder pattern

     CartSetLineItemRecurrenceInfoAction cartSetLineItemRecurrenceInfoAction = CartSetLineItemRecurrenceInfoAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_RECURRENCE_INFO	discriminator value for CartSetLineItemRecurrenceInfoAction

Method Summary

Modifier and Type	Method	Description
static CartSetLineItemRecurrenceInfoActionBuilder	builder()	builder factory method for CartSetLineItemRecurrenceInfoAction
static CartSetLineItemRecurrenceInfoActionBuilder	builder(CartSetLineItemRecurrenceInfoAction template)	create builder for CartSetLineItemRecurrenceInfoAction instance
CartSetLineItemRecurrenceInfoAction	copyDeep()
static CartSetLineItemRecurrenceInfoAction	deepCopy(CartSetLineItemRecurrenceInfoAction template)	factory method to create a deep copy of CartSetLineItemRecurrenceInfoAction
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
@Valid LineItemRecurrenceInfoDraft	getRecurrenceInfo()	Value to set.
static CartSetLineItemRecurrenceInfoAction	of()	factory method
static CartSetLineItemRecurrenceInfoAction	of(CartSetLineItemRecurrenceInfoAction template)	factory method to create a shallow copy CartSetLineItemRecurrenceInfoAction
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setRecurrenceInfo(LineItemRecurrenceInfoDraft recurrenceInfo)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<CartSetLineItemRecurrenceInfoAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetLineItemRecurrenceInfoAction(Function<CartSetLineItemRecurrenceInfoAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

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

get

Field Details

SET_LINE_ITEM_RECURRENCE_INFO

static final String SET_LINE_ITEM_RECURRENCE_INFO

discriminator value for CartSetLineItemRecurrenceInfoAction

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

getRecurrenceInfo

@Valid
@Valid LineItemRecurrenceInfoDraft getRecurrenceInfo()

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

Returns:

recurrenceInfo

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

setRecurrenceInfo

void setRecurrenceInfo(LineItemRecurrenceInfoDraft recurrenceInfo)

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

Parameters:

recurrenceInfo - value to be set

of

static CartSetLineItemRecurrenceInfoAction of()

factory method

Returns:

instance of CartSetLineItemRecurrenceInfoAction

of

static CartSetLineItemRecurrenceInfoAction of(CartSetLineItemRecurrenceInfoAction template)

factory method to create a shallow copy CartSetLineItemRecurrenceInfoAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartSetLineItemRecurrenceInfoAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartSetLineItemRecurrenceInfoAction deepCopy(@Nullable
 CartSetLineItemRecurrenceInfoAction template)

factory method to create a deep copy of CartSetLineItemRecurrenceInfoAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetLineItemRecurrenceInfoActionBuilder builder()

builder factory method for CartSetLineItemRecurrenceInfoAction

Returns:

builder

builder

static CartSetLineItemRecurrenceInfoActionBuilder builder(CartSetLineItemRecurrenceInfoAction template)

create builder for CartSetLineItemRecurrenceInfoAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetLineItemRecurrenceInfoAction

default <T> T withCartSetLineItemRecurrenceInfoAction(Function<CartSetLineItemRecurrenceInfoAction,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<CartSetLineItemRecurrenceInfoAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference