Interface SetOrderLineItemCustomFieldChange
- All Superinterfaces:
Change
Change triggered by the following update actions:
- Set LineItem CustomField on Orders.
- Set LineItem CustomField on Staged Orders.
Example to create an instance using the builder pattern
SetOrderLineItemCustomFieldChange setOrderLineItemCustomFieldChange = SetOrderLineItemCustomFieldChange.builder()
.change("{change}")
.customTypeId("{customTypeId}")
.name("{name}")
.lineItem(lineItemBuilder -> lineItemBuilder)
.variant("{variant}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringdiscriminator value for SetOrderLineItemCustomFieldChange -
Method Summary
Modifier and TypeMethodDescriptionbuilder()builder factory method for SetOrderLineItemCustomFieldChangebuilder(SetOrderLineItemCustomFieldChange template) create builder for SetOrderLineItemCustomFieldChange instancecopyDeep()deepCopy(SetOrderLineItemCustomFieldChange template) factory method to create a deep copy of SetOrderLineItemCustomFieldChange@NotNull StringType of change on a resource that is similar to the update action it relates to, where possible.@NotNull Stringidof the referenced Type.@NotNull @Valid LocalizedStringName of the Product the Line Item is based on.@NotNull StringgetName()Name of the Custom Field.@NotNull ObjectValue after the change.@NotNull ObjectValue before the change.@NotNull StringgetType()Unique discriminator value to reliably deserialize the data type.@NotNull Stringof()factory methodof(SetOrderLineItemCustomFieldChange template) factory method to create a shallow copy SetOrderLineItemCustomFieldChangevoidset changevoidsetCustomTypeId(String customTypeId) idof the referenced Type.voidsetLineItem(LocalizedString lineItem) Name of the Product the Line Item is based on.voidName of the Custom Field.voidsetNextValue(Object nextValue) Value after the change.voidsetPreviousValue(Object previousValue) Value before the change.voidsetVariant(String variant) static com.fasterxml.jackson.core.type.TypeReference<SetOrderLineItemCustomFieldChange>gives a TypeReference for usage with Jackson DataBinddefault <T> Taccessor map functionMethods inherited from interface com.commercetools.history.models.change.Change
withChange
-
Field Details
-
SET_ORDER_LINE_ITEM_CUSTOM_FIELD_CHANGE
discriminator value for SetOrderLineItemCustomFieldChange- See Also:
-
-
Method Details
-
getType
Description copied from interface:ChangeUnique discriminator value to reliably deserialize the data type.
-
getChange
Description copied from interface:ChangeType of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the
setDescriptionchange can occur with a localized and non-localized representation.Records can be filtered by this value using the
changesquery parameter. -
getPreviousValue
Value before the change.
- Returns:
- previousValue
-
getNextValue
Value after the change.
- Returns:
- nextValue
-
getCustomTypeId
idof the referenced Type.- Returns:
- customTypeId
-
getName
Name of the Custom Field.
- Returns:
- name
-
getLineItem
Name of the Product the Line Item is based on.
- Returns:
- lineItem
-
getVariant
skuorkeyof the ProductVariant.- Returns:
- variant
-
setChange
set change -
setPreviousValue
Value before the change.
- Parameters:
previousValue- value to be set
-
setNextValue
Value after the change.
- Parameters:
nextValue- value to be set
-
setCustomTypeId
idof the referenced Type.- Parameters:
customTypeId- value to be set
-
setName
Name of the Custom Field.
- Parameters:
name- value to be set
-
setLineItem
Name of the Product the Line Item is based on.
- Parameters:
lineItem- value to be set
-
setVariant
skuorkeyof the ProductVariant.- Parameters:
variant- value to be set
-
of
factory method- Returns:
- instance of SetOrderLineItemCustomFieldChange
-
of
factory method to create a shallow copy SetOrderLineItemCustomFieldChange- Parameters:
template- instance to be copied- Returns:
- copy instance
-
copyDeep
SetOrderLineItemCustomFieldChange copyDeep() -
deepCopy
@Nullable static SetOrderLineItemCustomFieldChange deepCopy(@Nullable SetOrderLineItemCustomFieldChange template) factory method to create a deep copy of SetOrderLineItemCustomFieldChange- Parameters:
template- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for SetOrderLineItemCustomFieldChange- Returns:
- builder
-
builder
create builder for SetOrderLineItemCustomFieldChange instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-
withSetOrderLineItemCustomFieldChange
default <T> T withSetOrderLineItemCustomFieldChange(Function<SetOrderLineItemCustomFieldChange, 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<SetOrderLineItemCustomFieldChange> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-