Package com.commercetools.history.models.change

Interface SetDeliveryItemsChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetDeliveryItemsChangeImpl

public interface SetDeliveryItemsChange
extends Change

Change triggered by the following update actions:

• Set Delivery Items on Orders.
• Set Delivery Items on Staged Orders.

Example to create an instance using the builder pattern

     SetDeliveryItemsChange setDeliveryItemsChange = SetDeliveryItemsChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_ITEMS_CHANGE	discriminator value for SetDeliveryItemsChange

Method Summary

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

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

withChange

Field Details

SET_DELIVERY_ITEMS_CHANGE

static final String SET_DELIVERY_ITEMS_CHANGE

discriminator value for SetDeliveryItemsChange

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

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

id of the updated Delivery.

Returns:

deliveryId

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

setDeliveryId

void setDeliveryId(String deliveryId)

id of the updated Delivery.

Parameters:

deliveryId - value to be set

of

static SetDeliveryItemsChange of()

factory method

Returns:

instance of SetDeliveryItemsChange

of

static SetDeliveryItemsChange of(SetDeliveryItemsChange template)

factory method to create a shallow copy SetDeliveryItemsChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetDeliveryItemsChange deepCopy(@Nullable
 SetDeliveryItemsChange template)

factory method to create a deep copy of SetDeliveryItemsChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetDeliveryItemsChangeBuilder builder()

builder factory method for SetDeliveryItemsChange

Returns:

builder

builder

static SetDeliveryItemsChangeBuilder builder(SetDeliveryItemsChange template)

create builder for SetDeliveryItemsChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetDeliveryItemsChange

default <T> T withSetDeliveryItemsChange(Function<SetDeliveryItemsChange,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<SetDeliveryItemsChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference