Interface StagedOrderSetReturnItemCustomFieldAction
- All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>,StagedOrderUpdateAction
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldAction stagedOrderSetReturnItemCustomFieldAction = StagedOrderSetReturnItemCustomFieldAction.builder()
.name("{name}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringdiscriminator value for StagedOrderSetReturnItemCustomFieldAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()builder factory method for StagedOrderSetReturnItemCustomFieldActioncreate builder for StagedOrderSetReturnItemCustomFieldAction instancecopyDeep()factory method to create a deep copy of StagedOrderSetReturnItemCustomFieldAction@NotNull StringgetName()Name of the Custom Field.idof the ReturnItem to update.keyof the ReturnItem to update.getValue()Ifvalueis absent ornull, this field will be removed if it exists.of()factory methodof(StagedOrderSetReturnItemCustomFieldAction template) factory method to create a shallow copy StagedOrderSetReturnItemCustomFieldActionvoidName of the Custom Field.voidsetReturnItemId(String returnItemId) idof the ReturnItem to update.voidsetReturnItemKey(String returnItemKey) keyof the ReturnItem to update.voidIfvalueis absent ornull, this field will be removed if it exists.static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetReturnItemCustomFieldAction>gives a TypeReference for usage with Jackson DataBinddefault <T> TwithStagedOrderSetReturnItemCustomFieldAction(Function<StagedOrderSetReturnItemCustomFieldAction, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
getMethods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction
getAction, withStagedOrderUpdateAction
-
Field Details
-
SET_RETURN_ITEM_CUSTOM_FIELD
discriminator value for StagedOrderSetReturnItemCustomFieldAction- See Also:
-
-
Method Details
-
getReturnItemId
String getReturnItemId()idof the ReturnItem to update. EitherreturnItemIdorreturnItemKeyis required.- Returns:
- returnItemId
-
getReturnItemKey
String getReturnItemKey()keyof the ReturnItem to update. EitherreturnItemIdorreturnItemKeyis required.- Returns:
- returnItemKey
-
getName
Name of the Custom Field.
- Returns:
- name
-
getValue
Object getValue()If
valueis absent ornull, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalueis provided, it is set for the field defined byname.- Returns:
- value
-
setReturnItemId
idof the ReturnItem to update. EitherreturnItemIdorreturnItemKeyis required.- Parameters:
returnItemId- value to be set
-
setReturnItemKey
keyof the ReturnItem to update. EitherreturnItemIdorreturnItemKeyis required.- Parameters:
returnItemKey- value to be set
-
setName
Name of the Custom Field.
- Parameters:
name- value to be set
-
setValue
If
valueis absent ornull, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalueis provided, it is set for the field defined byname.- Parameters:
value- value to be set
-
of
factory method- Returns:
- instance of StagedOrderSetReturnItemCustomFieldAction
-
of
static StagedOrderSetReturnItemCustomFieldAction of(StagedOrderSetReturnItemCustomFieldAction template) factory method to create a shallow copy StagedOrderSetReturnItemCustomFieldAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
copyDeep
StagedOrderSetReturnItemCustomFieldAction copyDeep()- Specified by:
copyDeepin interfaceStagedOrderUpdateAction
-
deepCopy
@Nullable static StagedOrderSetReturnItemCustomFieldAction deepCopy(@Nullable StagedOrderSetReturnItemCustomFieldAction template) factory method to create a deep copy of StagedOrderSetReturnItemCustomFieldAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for StagedOrderSetReturnItemCustomFieldAction- Returns:
- builder
-
builder
static StagedOrderSetReturnItemCustomFieldActionBuilder builder(StagedOrderSetReturnItemCustomFieldAction template) create builder for StagedOrderSetReturnItemCustomFieldAction instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-
withStagedOrderSetReturnItemCustomFieldAction
default <T> T withStagedOrderSetReturnItemCustomFieldAction(Function<StagedOrderSetReturnItemCustomFieldAction, T> helper) accessor map function- Type Parameters:
T- mapped type- Parameters:
helper- function to map the object- Returns:
- mapped value
-
ofUnset
-
typeReference
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetReturnItemCustomFieldAction> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-