Package com.commercetools.history.models.change

Interface RemoveParcelFromDeliveryChange

All Superinterfaces:

Change

All Known Implementing Classes:

RemoveParcelFromDeliveryChangeImpl

public interface RemoveParcelFromDeliveryChange
extends Change

Change triggered by the following update actions:

• Remove Parcel From Delivery on Orders.
• Remove Parcel From Delivery on Staged Orders.

Example to create an instance using the builder pattern

     RemoveParcelFromDeliveryChange removeParcelFromDeliveryChange = RemoveParcelFromDeliveryChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_PARCEL_FROM_DELIVERY_CHANGE	discriminator value for RemoveParcelFromDeliveryChange

Method Summary

Modifier and Type	Method	Description
static RemoveParcelFromDeliveryChangeBuilder	builder()	builder factory method for RemoveParcelFromDeliveryChange
static RemoveParcelFromDeliveryChangeBuilder	builder(RemoveParcelFromDeliveryChange template)	create builder for RemoveParcelFromDeliveryChange instance
static RemoveParcelFromDeliveryChange	deepCopy(RemoveParcelFromDeliveryChange template)	factory method to create a deep copy of RemoveParcelFromDeliveryChange
@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 Delivery from which the Parcel was removed.
@NotNull @Valid Parcel	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static RemoveParcelFromDeliveryChange	of()	factory method
static RemoveParcelFromDeliveryChange	of(RemoveParcelFromDeliveryChange template)	factory method to create a shallow copy RemoveParcelFromDeliveryChange
void	setChange(String change)	set change
void	setDeliveryId(String deliveryId)	id of the Delivery from which the Parcel was removed.
void	setPreviousValue(Parcel previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<RemoveParcelFromDeliveryChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withRemoveParcelFromDeliveryChange(Function<RemoveParcelFromDeliveryChange,T> helper)	accessor map function

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

withChange

Field Details

REMOVE_PARCEL_FROM_DELIVERY_CHANGE

static final String REMOVE_PARCEL_FROM_DELIVERY_CHANGE

discriminator value for RemoveParcelFromDeliveryChange

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

Value before the change.

Returns:

previousValue

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

id of the Delivery from which the Parcel was removed.

Returns:

deliveryId

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(Parcel previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

id of the Delivery from which the Parcel was removed.

Parameters:

deliveryId - value to be set

of

static RemoveParcelFromDeliveryChange of()

factory method

Returns:

instance of RemoveParcelFromDeliveryChange

of

static RemoveParcelFromDeliveryChange of(RemoveParcelFromDeliveryChange template)

factory method to create a shallow copy RemoveParcelFromDeliveryChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static RemoveParcelFromDeliveryChange deepCopy(@Nullable
 RemoveParcelFromDeliveryChange template)

factory method to create a deep copy of RemoveParcelFromDeliveryChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RemoveParcelFromDeliveryChangeBuilder builder()

builder factory method for RemoveParcelFromDeliveryChange

Returns:

builder

builder

static RemoveParcelFromDeliveryChangeBuilder builder(RemoveParcelFromDeliveryChange template)

create builder for RemoveParcelFromDeliveryChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRemoveParcelFromDeliveryChange

default <T> T withRemoveParcelFromDeliveryChange(Function<RemoveParcelFromDeliveryChange,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<RemoveParcelFromDeliveryChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference