Package com.commercetools.history.models.change

Interface SetCustomLineItemCustomTypeChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetCustomLineItemCustomTypeChangeImpl

public interface SetCustomLineItemCustomTypeChange
extends Change

Change triggered by the following update actions:

• Set CustomLineItem CustomField on Orders.
• Set CustomLineItem CustomField on Staged Orders.

Example to create an instance using the builder pattern

     SetCustomLineItemCustomTypeChange setCustomLineItemCustomTypeChange = SetCustomLineItemCustomTypeChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .customLineItem(customLineItemBuilder -> customLineItemBuilder)
             .customLineItemId("{customLineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_CUSTOM_TYPE_CHANGE	discriminator value for SetCustomLineItemCustomTypeChange

Method Summary

Modifier and Type	Method	Description
static SetCustomLineItemCustomTypeChangeBuilder	builder()	builder factory method for SetCustomLineItemCustomTypeChange
static SetCustomLineItemCustomTypeChangeBuilder	builder(SetCustomLineItemCustomTypeChange template)	create builder for SetCustomLineItemCustomTypeChange instance
static SetCustomLineItemCustomTypeChange	deepCopy(SetCustomLineItemCustomTypeChange template)	factory method to create a deep copy of SetCustomLineItemCustomTypeChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid LocalizedString	getCustomLineItem()	Name of the updated CustomLineItem.
@NotNull String	getCustomLineItemId()	id of the updated CustomLineItem.
@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.
static SetCustomLineItemCustomTypeChange	of()	factory method
static SetCustomLineItemCustomTypeChange	of(SetCustomLineItemCustomTypeChange template)	factory method to create a shallow copy SetCustomLineItemCustomTypeChange
void	setChange(String change)	set change
void	setCustomLineItem(LocalizedString customLineItem)	Name of the updated CustomLineItem.
void	setCustomLineItemId(String customLineItemId)	id of the updated CustomLineItem.
void	setNextValue(CustomFields nextValue)	Value after the change.
void	setPreviousValue(CustomFields previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetCustomLineItemCustomTypeChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetCustomLineItemCustomTypeChange(Function<SetCustomLineItemCustomTypeChange,T> helper)	accessor map function

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

withChange

Field Details

SET_CUSTOM_LINE_ITEM_CUSTOM_TYPE_CHANGE

static final String SET_CUSTOM_LINE_ITEM_CUSTOM_TYPE_CHANGE

discriminator value for SetCustomLineItemCustomTypeChange

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

getCustomLineItem

@NotNull
@Valid
@NotNull @Valid LocalizedString getCustomLineItem()

Name of the updated CustomLineItem.

Returns:

customLineItem

getCustomLineItemId

@NotNull
@NotNull String getCustomLineItemId()

id of the updated CustomLineItem.

Returns:

customLineItemId

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

setCustomLineItem

void setCustomLineItem(LocalizedString customLineItem)

Name of the updated CustomLineItem.

Parameters:

customLineItem - value to be set

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the updated CustomLineItem.

Parameters:

customLineItemId - value to be set

of

static SetCustomLineItemCustomTypeChange of()

factory method

Returns:

instance of SetCustomLineItemCustomTypeChange

of

static SetCustomLineItemCustomTypeChange of(SetCustomLineItemCustomTypeChange template)

factory method to create a shallow copy SetCustomLineItemCustomTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetCustomLineItemCustomTypeChange deepCopy(@Nullable
 SetCustomLineItemCustomTypeChange template)

factory method to create a deep copy of SetCustomLineItemCustomTypeChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetCustomLineItemCustomTypeChangeBuilder builder()

builder factory method for SetCustomLineItemCustomTypeChange

Returns:

builder

builder

static SetCustomLineItemCustomTypeChangeBuilder builder(SetCustomLineItemCustomTypeChange template)

create builder for SetCustomLineItemCustomTypeChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetCustomLineItemCustomTypeChange

default <T> T withSetCustomLineItemCustomTypeChange(Function<SetCustomLineItemCustomTypeChange,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<SetCustomLineItemCustomTypeChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference