Package com.commercetools.history.models.change

Interface SetCustomLineItemShippingDetailsChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetCustomLineItemShippingDetailsChangeImpl

public interface SetCustomLineItemShippingDetailsChange
extends Change

Change triggered by the following update actions:

• Set CustomLineItem ShippingDetails on Orders.
• Set CustomLineItem ShippingDetails on Staged Orders.

Example to create an instance using the builder pattern

     SetCustomLineItemShippingDetailsChange setCustomLineItemShippingDetailsChange = SetCustomLineItemShippingDetailsChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .customLineItemId("{customLineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_SHIPPING_DETAILS_CHANGE	discriminator value for SetCustomLineItemShippingDetailsChange

Method Summary

Modifier and Type	Method	Description
static SetCustomLineItemShippingDetailsChangeBuilder	builder()	builder factory method for SetCustomLineItemShippingDetailsChange
static SetCustomLineItemShippingDetailsChangeBuilder	builder(SetCustomLineItemShippingDetailsChange template)	create builder for SetCustomLineItemShippingDetailsChange instance
static SetCustomLineItemShippingDetailsChange	deepCopy(SetCustomLineItemShippingDetailsChange template)	factory method to create a deep copy of SetCustomLineItemShippingDetailsChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getCustomLineItemId()	id of the updated CustomLineItem.
@NotNull @Valid ItemShippingDetails	getNextValue()	Value after the change.
@NotNull @Valid ItemShippingDetails	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static SetCustomLineItemShippingDetailsChange	of()	factory method
static SetCustomLineItemShippingDetailsChange	of(SetCustomLineItemShippingDetailsChange template)	factory method to create a shallow copy SetCustomLineItemShippingDetailsChange
void	setChange(String change)	set change
void	setCustomLineItemId(String customLineItemId)	id of the updated CustomLineItem.
void	setNextValue(ItemShippingDetails nextValue)	Value after the change.
void	setPreviousValue(ItemShippingDetails previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetCustomLineItemShippingDetailsChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetCustomLineItemShippingDetailsChange(Function<SetCustomLineItemShippingDetailsChange,T> helper)	accessor map function

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

withChange

Field Details

SET_CUSTOM_LINE_ITEM_SHIPPING_DETAILS_CHANGE

static final String SET_CUSTOM_LINE_ITEM_SHIPPING_DETAILS_CHANGE

discriminator value for SetCustomLineItemShippingDetailsChange

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

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid ItemShippingDetails getNextValue()

Value after the change.

Returns:

nextValue

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(ItemShippingDetails previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ItemShippingDetails nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the updated CustomLineItem.

Parameters:

customLineItemId - value to be set

of

static SetCustomLineItemShippingDetailsChange of()

factory method

Returns:

instance of SetCustomLineItemShippingDetailsChange

of

static SetCustomLineItemShippingDetailsChange of(SetCustomLineItemShippingDetailsChange template)

factory method to create a shallow copy SetCustomLineItemShippingDetailsChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetCustomLineItemShippingDetailsChange deepCopy(@Nullable
 SetCustomLineItemShippingDetailsChange template)

factory method to create a deep copy of SetCustomLineItemShippingDetailsChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetCustomLineItemShippingDetailsChangeBuilder builder()

builder factory method for SetCustomLineItemShippingDetailsChange

Returns:

builder

builder

static SetCustomLineItemShippingDetailsChangeBuilder builder(SetCustomLineItemShippingDetailsChange template)

create builder for SetCustomLineItemShippingDetailsChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetCustomLineItemShippingDetailsChange

default <T> T withSetCustomLineItemShippingDetailsChange(Function<SetCustomLineItemShippingDetailsChange,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<SetCustomLineItemShippingDetailsChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference