Package com.commercetools.history.models.change

Interface SetOrderLineItemCustomTypeChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetOrderLineItemCustomTypeChangeImpl

public interface SetOrderLineItemCustomTypeChange
extends Change

Change triggered by the following update actions:

• Set LineItem Custom Type on Orders.
• Set LineItem Custom Type on Staged Orders.

Example to create an instance using the builder pattern

     SetOrderLineItemCustomTypeChange setOrderLineItemCustomTypeChange = SetOrderLineItemCustomTypeChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .lineItem(lineItemBuilder -> lineItemBuilder)
             .variant("{variant}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ORDER_LINE_ITEM_CUSTOM_TYPE_CHANGE	discriminator value for SetOrderLineItemCustomTypeChange

Method Summary

Modifier and Type	Method	Description
static SetOrderLineItemCustomTypeChangeBuilder	builder()	builder factory method for SetOrderLineItemCustomTypeChange
static SetOrderLineItemCustomTypeChangeBuilder	builder(SetOrderLineItemCustomTypeChange template)	create builder for SetOrderLineItemCustomTypeChange instance
static SetOrderLineItemCustomTypeChange	deepCopy(SetOrderLineItemCustomTypeChange template)	factory method to create a deep copy of SetOrderLineItemCustomTypeChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid LocalizedString	getLineItem()	Name of the Product the updated Line Item is based on.
@NotNull @Valid CustomFields	getNextValue()	Value after the change.
@NotNull @Valid CustomFields	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 SetOrderLineItemCustomTypeChange	of()	factory method
static SetOrderLineItemCustomTypeChange	of(SetOrderLineItemCustomTypeChange template)	factory method to create a shallow copy SetOrderLineItemCustomTypeChange
void	setChange(String change)	set change
void	setLineItem(LocalizedString lineItem)	Name of the Product the updated Line Item is based on.
void	setNextValue(CustomFields nextValue)	Value after the change.
void	setPreviousValue(CustomFields previousValue)	Value before the change.
void	setVariant(String variant)	sku or key of the ProductVariant.
static com.fasterxml.jackson.core.type.TypeReference<SetOrderLineItemCustomTypeChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetOrderLineItemCustomTypeChange(Function<SetOrderLineItemCustomTypeChange,T> helper)	accessor map function

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

withChange

Field Details

SET_ORDER_LINE_ITEM_CUSTOM_TYPE_CHANGE

static final String SET_ORDER_LINE_ITEM_CUSTOM_TYPE_CHANGE

discriminator value for SetOrderLineItemCustomTypeChange

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
@Valid
@NotNull @Valid CustomFields getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid CustomFields getNextValue()

Value after the change.

Returns:

nextValue

getLineItem

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

Name of the Product the updated 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(CustomFields previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(CustomFields nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setLineItem

void setLineItem(LocalizedString lineItem)

Name of the Product the updated 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 SetOrderLineItemCustomTypeChange of()

factory method

Returns:

instance of SetOrderLineItemCustomTypeChange

of

static SetOrderLineItemCustomTypeChange of(SetOrderLineItemCustomTypeChange template)

factory method to create a shallow copy SetOrderLineItemCustomTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetOrderLineItemCustomTypeChange deepCopy(@Nullable
 SetOrderLineItemCustomTypeChange template)

factory method to create a deep copy of SetOrderLineItemCustomTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetOrderLineItemCustomTypeChangeBuilder builder()

builder factory method for SetOrderLineItemCustomTypeChange

Returns:

builder

builder

static SetOrderLineItemCustomTypeChangeBuilder builder(SetOrderLineItemCustomTypeChange template)

create builder for SetOrderLineItemCustomTypeChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetOrderLineItemCustomTypeChange

default <T> T withSetOrderLineItemCustomTypeChange(Function<SetOrderLineItemCustomTypeChange,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<SetOrderLineItemCustomTypeChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference