Package com.commercetools.history.models.change

Interface SetCustomLineItemCustomFieldChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetCustomLineItemCustomFieldChangeImpl

public interface SetCustomLineItemCustomFieldChange
extends Change

Change triggered by the following update actions:

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

Example to create an instance using the builder pattern

     SetCustomLineItemCustomFieldChange setCustomLineItemCustomFieldChange = SetCustomLineItemCustomFieldChange.builder()
             .change("{change}")
             .name("{name}")
             .customLineItem(customLineItemBuilder -> customLineItemBuilder)
             .customLineItemId("{customLineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD_CHANGE	discriminator value for SetCustomLineItemCustomFieldChange

Method Summary

Modifier and Type	Method	Description
static SetCustomLineItemCustomFieldChangeBuilder	builder()	builder factory method for SetCustomLineItemCustomFieldChange
static SetCustomLineItemCustomFieldChangeBuilder	builder(SetCustomLineItemCustomFieldChange template)	create builder for SetCustomLineItemCustomFieldChange instance
static SetCustomLineItemCustomFieldChange	deepCopy(SetCustomLineItemCustomFieldChange template)	factory method to create a deep copy of SetCustomLineItemCustomFieldChange
@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 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.
static SetCustomLineItemCustomFieldChange	of()	factory method
static SetCustomLineItemCustomFieldChange	of(SetCustomLineItemCustomFieldChange template)	factory method to create a shallow copy SetCustomLineItemCustomFieldChange
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	setName(String name)	Name of the Custom Field.
void	setNextValue(Object nextValue)	Value after the change.
void	setPreviousValue(Object previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetCustomLineItemCustomFieldChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetCustomLineItemCustomFieldChange(Function<SetCustomLineItemCustomFieldChange,T> helper)	accessor map function

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

withChange

Field Details

SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD_CHANGE

static final String SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD_CHANGE

discriminator value for SetCustomLineItemCustomFieldChange

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

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

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(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

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - 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 SetCustomLineItemCustomFieldChange of()

factory method

Returns:

instance of SetCustomLineItemCustomFieldChange

of

static SetCustomLineItemCustomFieldChange of(SetCustomLineItemCustomFieldChange template)

factory method to create a shallow copy SetCustomLineItemCustomFieldChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetCustomLineItemCustomFieldChange deepCopy(@Nullable
 SetCustomLineItemCustomFieldChange template)

factory method to create a deep copy of SetCustomLineItemCustomFieldChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetCustomLineItemCustomFieldChangeBuilder builder()

builder factory method for SetCustomLineItemCustomFieldChange

Returns:

builder

builder

static SetCustomLineItemCustomFieldChangeBuilder builder(SetCustomLineItemCustomFieldChange template)

create builder for SetCustomLineItemCustomFieldChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetCustomLineItemCustomFieldChange

default <T> T withSetCustomLineItemCustomFieldChange(Function<SetCustomLineItemCustomFieldChange,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<SetCustomLineItemCustomFieldChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference