Package com.commercetools.history.models.change

Interface SetOrderLineItemCustomFieldChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetOrderLineItemCustomFieldChangeImpl

public interface SetOrderLineItemCustomFieldChange
extends 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

Fields

Modifier and Type	Field	Description
static final String	SET_ORDER_LINE_ITEM_CUSTOM_FIELD_CHANGE	discriminator value for SetOrderLineItemCustomFieldChange

Method Summary

Modifier and Type	Method	Description
static SetOrderLineItemCustomFieldChangeBuilder	builder()	builder factory method for SetOrderLineItemCustomFieldChange
static SetOrderLineItemCustomFieldChangeBuilder	builder(SetOrderLineItemCustomFieldChange template)	create builder for SetOrderLineItemCustomFieldChange instance
static SetOrderLineItemCustomFieldChange	deepCopy(SetOrderLineItemCustomFieldChange template)	factory method to create a deep copy of SetOrderLineItemCustomFieldChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getCustomTypeId()	id of the referenced Type.
@NotNull @Valid LocalizedString	getLineItem()	Name of the Product the Line Item is based on.
@NotNull String	getName()	Name of the Custom Field.
@NotNull Object	getNextValue()	Value after the change.
@NotNull Object	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
@NotNull String	getVariant()	sku or key of the ProductVariant.
static SetOrderLineItemCustomFieldChange	of()	factory method
static SetOrderLineItemCustomFieldChange	of(SetOrderLineItemCustomFieldChange template)	factory method to create a shallow copy SetOrderLineItemCustomFieldChange
void	setChange(String change)	set change
void	setCustomTypeId(String customTypeId)	id of the referenced Type.
void	setLineItem(LocalizedString lineItem)	Name of the Product the Line Item is based on.
void	setName(String name)	Name of the Custom Field.
void	setNextValue(Object nextValue)	Value after the change.
void	setPreviousValue(Object previousValue)	Value before the change.
void	setVariant(String variant)	sku or key of the ProductVariant.
static com.fasterxml.jackson.core.type.TypeReference<SetOrderLineItemCustomFieldChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetOrderLineItemCustomFieldChange(Function<SetOrderLineItemCustomFieldChange,T> helper)	accessor map function

Methods inherited from interface com.commercetools.history.models.change.Change

withChange

Field Details

SET_ORDER_LINE_ITEM_CUSTOM_FIELD_CHANGE

static final String SET_ORDER_LINE_ITEM_CUSTOM_FIELD_CHANGE

discriminator value for SetOrderLineItemCustomFieldChange

See Also:

• Constant Field Values

Method Details

getType

@NotNull
@NotNull String getType()

Description copied from interface: Change

Unique discriminator value to reliably deserialize the data type.

Specified by:

getType in interface Change

Returns:

type

getChange

@NotNull
@NotNull String getChange()

Description copied from interface: Change

Type 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 setDescription change can occur with a localized and non-localized representation.

Records can be filtered by this value using the changes query parameter.

Specified by:

getChange in interface Change

Returns:

change

getPreviousValue

@NotNull
@NotNull Object getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull Object getNextValue()

Value after the change.

Returns:

nextValue

getCustomTypeId

@NotNull
@NotNull String getCustomTypeId()

id of the referenced Type.

Returns:

customTypeId

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getLineItem

@NotNull
@Valid
@NotNull @Valid LocalizedString getLineItem()

Name of the Product the Line Item is based on.

Returns:

lineItem

getVariant

@NotNull
@NotNull String getVariant()

sku or key of the ProductVariant.

Returns:

variant

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(Object previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(Object nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setCustomTypeId

void setCustomTypeId(String customTypeId)

id of the referenced Type.

Parameters:

customTypeId - value to be set

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setLineItem

void setLineItem(LocalizedString lineItem)

Name of the Product the Line Item is based on.

Parameters:

lineItem - value to be set

setVariant

void setVariant(String variant)

sku or key of the ProductVariant.

Parameters:

variant - value to be set

of

static SetOrderLineItemCustomFieldChange of()

factory method

Returns:

instance of SetOrderLineItemCustomFieldChange

of

static SetOrderLineItemCustomFieldChange of(SetOrderLineItemCustomFieldChange template)

factory method to create a shallow copy SetOrderLineItemCustomFieldChange

Parameters:

template - instance to be copied

Returns:

copy instance

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

static SetOrderLineItemCustomFieldChangeBuilder builder()

builder factory method for SetOrderLineItemCustomFieldChange

Returns:

builder

builder

static SetOrderLineItemCustomFieldChangeBuilder builder(SetOrderLineItemCustomFieldChange template)

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