Package com.commercetools.history.models.change

Interface SetDeliveryAddressChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetDeliveryAddressChangeImpl

public interface SetDeliveryAddressChange
extends Change

Change triggered by the following update actions:

• Set DeliveryAddress on Orders.
• Set DeliveryAddress on Staged Orders.

Example to create an instance using the builder pattern

     SetDeliveryAddressChange setDeliveryAddressChange = SetDeliveryAddressChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .deliveryId("{deliveryId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DELIVERY_ADDRESS_CHANGE	discriminator value for SetDeliveryAddressChange

Method Summary

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

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

withChange

Field Details

SET_DELIVERY_ADDRESS_CHANGE

static final String SET_DELIVERY_ADDRESS_CHANGE

discriminator value for SetDeliveryAddressChange

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

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid Address 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(Address previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(Address nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setDeliveryId

void setDeliveryId(String deliveryId)

id of the updated Delivery.

Parameters:

deliveryId - value to be set

of

static SetDeliveryAddressChange of()

factory method

Returns:

instance of SetDeliveryAddressChange

of

static SetDeliveryAddressChange of(SetDeliveryAddressChange template)

factory method to create a shallow copy SetDeliveryAddressChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetDeliveryAddressChange deepCopy(@Nullable
 SetDeliveryAddressChange template)

factory method to create a deep copy of SetDeliveryAddressChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetDeliveryAddressChangeBuilder builder()

builder factory method for SetDeliveryAddressChange

Returns:

builder

builder

static SetDeliveryAddressChangeBuilder builder(SetDeliveryAddressChange template)

create builder for SetDeliveryAddressChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetDeliveryAddressChange

default <T> T withSetDeliveryAddressChange(Function<SetDeliveryAddressChange,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<SetDeliveryAddressChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference