Package com.commercetools.history.models.change

Interface SetParcelItemsChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetParcelItemsChangeImpl

public interface SetParcelItemsChange
extends Change

Change triggered by the following update actions:

• Set Parcel Items on Orders.
• Set Parcel Items on Staged Orders.

Example to create an instance using the builder pattern

     SetParcelItemsChange setParcelItemsChange = SetParcelItemsChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .parcel(parcelBuilder -> parcelBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_PARCEL_ITEMS_CHANGE	discriminator value for SetParcelItemsChange

Method Summary

Modifier and Type	Method	Description
static SetParcelItemsChangeBuilder	builder()	builder factory method for SetParcelItemsChange
static SetParcelItemsChangeBuilder	builder(SetParcelItemsChange template)	create builder for SetParcelItemsChange instance
static SetParcelItemsChange	deepCopy(SetParcelItemsChange template)	factory method to create a deep copy of SetParcelItemsChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid List<DeliveryItem>	getNextValue()	Value after the change.
@NotNull @Valid ParcelChangeValue	getParcel()	Information about the updated Parcel.
@NotNull @Valid List<DeliveryItem>	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static SetParcelItemsChange	of()	factory method
static SetParcelItemsChange	of(SetParcelItemsChange template)	factory method to create a shallow copy SetParcelItemsChange
void	setChange(String change)	set change
void	setNextValue(DeliveryItem... nextValue)	Value after the change.
void	setNextValue(List<DeliveryItem> nextValue)	Value after the change.
void	setParcel(ParcelChangeValue parcel)	Information about the updated Parcel.
void	setPreviousValue(DeliveryItem... previousValue)	Value before the change.
void	setPreviousValue(List<DeliveryItem> previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetParcelItemsChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetParcelItemsChange(Function<SetParcelItemsChange,T> helper)	accessor map function

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

withChange

Field Details

SET_PARCEL_ITEMS_CHANGE

static final String SET_PARCEL_ITEMS_CHANGE

discriminator value for SetParcelItemsChange

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 List<DeliveryItem> getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid List<DeliveryItem> getNextValue()

Value after the change.

Returns:

nextValue

getParcel

@NotNull
@Valid
@NotNull @Valid ParcelChangeValue getParcel()

Information about the updated Parcel.

Returns:

parcel

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(DeliveryItem... previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setPreviousValue

void setPreviousValue(List<DeliveryItem> previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setNextValue

void setNextValue(DeliveryItem... nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setNextValue

void setNextValue(List<DeliveryItem> nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setParcel

void setParcel(ParcelChangeValue parcel)

Information about the updated Parcel.

Parameters:

parcel - value to be set

of

static SetParcelItemsChange of()

factory method

Returns:

instance of SetParcelItemsChange

of

static SetParcelItemsChange of(SetParcelItemsChange template)

factory method to create a shallow copy SetParcelItemsChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetParcelItemsChange deepCopy(@Nullable
 SetParcelItemsChange template)

factory method to create a deep copy of SetParcelItemsChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetParcelItemsChangeBuilder builder()

builder factory method for SetParcelItemsChange

Returns:

builder

builder

static SetParcelItemsChangeBuilder builder(SetParcelItemsChange template)

create builder for SetParcelItemsChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetParcelItemsChange

default <T> T withSetParcelItemsChange(Function<SetParcelItemsChange,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<SetParcelItemsChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference