Package com.commercetools.history.models.change

Interface ChangeLineItemQuantityChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeLineItemQuantityChangeImpl

public interface ChangeLineItemQuantityChange
extends Change

Change triggered by the Change LineItem Quantity update action.

Example to create an instance using the builder pattern

     ChangeLineItemQuantityChange changeLineItemQuantityChange = ChangeLineItemQuantityChange.builder()
             .change("{change}")
             .previousValue(1)
             .nextValue(1)
             .lineItem(lineItemBuilder -> lineItemBuilder)
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_LINE_ITEM_QUANTITY_CHANGE	discriminator value for ChangeLineItemQuantityChange

Method Summary

Modifier and Type	Method	Description
static ChangeLineItemQuantityChangeBuilder	builder()	builder factory method for ChangeLineItemQuantityChange
static ChangeLineItemQuantityChangeBuilder	builder(ChangeLineItemQuantityChange template)	create builder for ChangeLineItemQuantityChange instance
static ChangeLineItemQuantityChange	deepCopy(ChangeLineItemQuantityChange template)	factory method to create a deep copy of ChangeLineItemQuantityChange
@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 String	getLineItemId()	id of the updated LineItem.
@NotNull Integer	getNextValue()	Value after the change
@NotNull Integer	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static ChangeLineItemQuantityChange	of()	factory method
static ChangeLineItemQuantityChange	of(ChangeLineItemQuantityChange template)	factory method to create a shallow copy ChangeLineItemQuantityChange
void	setChange(String change)	set change
void	setLineItem(LocalizedString lineItem)	Name of the Product the updated Line Item is based on.
void	setLineItemId(String lineItemId)	id of the updated LineItem.
void	setNextValue(Integer nextValue)	Value after the change
void	setPreviousValue(Integer previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<ChangeLineItemQuantityChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeLineItemQuantityChange(Function<ChangeLineItemQuantityChange,T> helper)	accessor map function

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

withChange

Field Details

CHANGE_LINE_ITEM_QUANTITY_CHANGE

static final String CHANGE_LINE_ITEM_QUANTITY_CHANGE

discriminator value for ChangeLineItemQuantityChange

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 Integer getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull Integer 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

getLineItemId

@NotNull
@NotNull String getLineItemId()

id of the updated LineItem.

Returns:

lineItemId

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(Integer previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(Integer 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

setLineItemId

void setLineItemId(String lineItemId)

id of the updated LineItem.

Parameters:

lineItemId - value to be set

of

static ChangeLineItemQuantityChange of()

factory method

Returns:

instance of ChangeLineItemQuantityChange

of

static ChangeLineItemQuantityChange of(ChangeLineItemQuantityChange template)

factory method to create a shallow copy ChangeLineItemQuantityChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeLineItemQuantityChange deepCopy(@Nullable
 ChangeLineItemQuantityChange template)

factory method to create a deep copy of ChangeLineItemQuantityChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeLineItemQuantityChangeBuilder builder()

builder factory method for ChangeLineItemQuantityChange

Returns:

builder

builder

static ChangeLineItemQuantityChangeBuilder builder(ChangeLineItemQuantityChange template)

create builder for ChangeLineItemQuantityChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeLineItemQuantityChange

default <T> T withChangeLineItemQuantityChange(Function<ChangeLineItemQuantityChange,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<ChangeLineItemQuantityChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference