Package com.commercetools.api.models.me
Interface MyCartSetLineItemRecurrenceInfoAction
- All Superinterfaces:
MyCartUpdateAction,ResourceUpdateAction<MyCartUpdateAction>
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
MyCartSetLineItemRecurrenceInfoAction myCartSetLineItemRecurrenceInfoAction = MyCartSetLineItemRecurrenceInfoAction.builder()
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringdiscriminator value for MyCartSetLineItemRecurrenceInfoAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()builder factory method for MyCartSetLineItemRecurrenceInfoActionbuilder(MyCartSetLineItemRecurrenceInfoAction template) create builder for MyCartSetLineItemRecurrenceInfoAction instancecopyDeep()factory method to create a deep copy of MyCartSetLineItemRecurrenceInfoActionidof the LineItem to update.keyof the LineItem to update.@Valid LineItemRecurrenceInfoDraftValue to set.of()factory methodof(MyCartSetLineItemRecurrenceInfoAction template) factory method to create a shallow copy MyCartSetLineItemRecurrenceInfoActionvoidsetLineItemId(String lineItemId) idof the LineItem to update.voidsetLineItemKey(String lineItemKey) keyof the LineItem to update.voidsetRecurrenceInfo(LineItemRecurrenceInfoDraft recurrenceInfo) Value to set.static com.fasterxml.jackson.core.type.TypeReference<MyCartSetLineItemRecurrenceInfoAction>gives a TypeReference for usage with Jackson DataBinddefault <T> Taccessor map functionMethods inherited from interface com.commercetools.api.models.me.MyCartUpdateAction
getAction, withMyCartUpdateActionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
-
Field Details
-
SET_LINE_ITEM_RECURRENCE_INFO
discriminator value for MyCartSetLineItemRecurrenceInfoAction- See Also:
-
-
Method Details
-
getLineItemId
String getLineItemId()idof the LineItem to update. EitherlineItemIdorlineItemKeyis required.- Returns:
- lineItemId
-
getLineItemKey
String getLineItemKey()keyof the LineItem to update. EitherlineItemIdorlineItemKeyis required.- Returns:
- lineItemKey
-
getRecurrenceInfo
Value to set. If empty, any existing value will be removed.
- Returns:
- recurrenceInfo
-
setLineItemId
idof the LineItem to update. EitherlineItemIdorlineItemKeyis required.- Parameters:
lineItemId- value to be set
-
setLineItemKey
keyof the LineItem to update. EitherlineItemIdorlineItemKeyis required.- Parameters:
lineItemKey- value to be set
-
setRecurrenceInfo
Value to set. If empty, any existing value will be removed.
- Parameters:
recurrenceInfo- value to be set
-
of
factory method- Returns:
- instance of MyCartSetLineItemRecurrenceInfoAction
-
of
factory method to create a shallow copy MyCartSetLineItemRecurrenceInfoAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
copyDeep
MyCartSetLineItemRecurrenceInfoAction copyDeep()- Specified by:
copyDeepin interfaceMyCartUpdateAction
-
deepCopy
@Nullable static MyCartSetLineItemRecurrenceInfoAction deepCopy(@Nullable MyCartSetLineItemRecurrenceInfoAction template) factory method to create a deep copy of MyCartSetLineItemRecurrenceInfoAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for MyCartSetLineItemRecurrenceInfoAction- Returns:
- builder
-
builder
static MyCartSetLineItemRecurrenceInfoActionBuilder builder(MyCartSetLineItemRecurrenceInfoAction template) create builder for MyCartSetLineItemRecurrenceInfoAction instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-
withMyCartSetLineItemRecurrenceInfoAction
default <T> T withMyCartSetLineItemRecurrenceInfoAction(Function<MyCartSetLineItemRecurrenceInfoAction, 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<MyCartSetLineItemRecurrenceInfoAction> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-