Package com.commercetools.history.models.change

Interface SetLineItemShippingDetailsChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetLineItemShippingDetailsChangeImpl

public interface SetLineItemShippingDetailsChange
extends Change

Change triggered by the following update actions:

• Set LineItem ShippingDetails on Orders.
• Set LineItem ShippingDetails on Staged Orders.

Example to create an instance using the builder pattern

     SetLineItemShippingDetailsChange setLineItemShippingDetailsChange = SetLineItemShippingDetailsChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_SHIPPING_DETAILS_CHANGE	discriminator value for SetLineItemShippingDetailsChange

Method Summary

Modifier and Type	Method	Description
static SetLineItemShippingDetailsChangeBuilder	builder()	builder factory method for SetLineItemShippingDetailsChange
static SetLineItemShippingDetailsChangeBuilder	builder(SetLineItemShippingDetailsChange template)	create builder for SetLineItemShippingDetailsChange instance
static SetLineItemShippingDetailsChange	deepCopy(SetLineItemShippingDetailsChange template)	factory method to create a deep copy of SetLineItemShippingDetailsChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getLineItemId()	id of the updated LineItem.
@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 SetLineItemShippingDetailsChange	of()	factory method
static SetLineItemShippingDetailsChange	of(SetLineItemShippingDetailsChange template)	factory method to create a shallow copy SetLineItemShippingDetailsChange
void	setChange(String change)	set change
void	setLineItemId(String lineItemId)	id of the updated LineItem.
void	setNextValue(ItemShippingDetails nextValue)	Value after the change.
void	setPreviousValue(ItemShippingDetails previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetLineItemShippingDetailsChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetLineItemShippingDetailsChange(Function<SetLineItemShippingDetailsChange,T> helper)	accessor map function

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

withChange

Field Details

SET_LINE_ITEM_SHIPPING_DETAILS_CHANGE

static final String SET_LINE_ITEM_SHIPPING_DETAILS_CHANGE

discriminator value for SetLineItemShippingDetailsChange

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

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

setLineItemId

void setLineItemId(String lineItemId)

id of the updated LineItem.

Parameters:

lineItemId - value to be set

of

static SetLineItemShippingDetailsChange of()

factory method

Returns:

instance of SetLineItemShippingDetailsChange

of

static SetLineItemShippingDetailsChange of(SetLineItemShippingDetailsChange template)

factory method to create a shallow copy SetLineItemShippingDetailsChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetLineItemShippingDetailsChange deepCopy(@Nullable
 SetLineItemShippingDetailsChange template)

factory method to create a deep copy of SetLineItemShippingDetailsChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetLineItemShippingDetailsChangeBuilder builder()

builder factory method for SetLineItemShippingDetailsChange

Returns:

builder

builder

static SetLineItemShippingDetailsChangeBuilder builder(SetLineItemShippingDetailsChange template)

create builder for SetLineItemShippingDetailsChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetLineItemShippingDetailsChange

default <T> T withSetLineItemShippingDetailsChange(Function<SetLineItemShippingDetailsChange,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<SetLineItemShippingDetailsChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference