Package com.commercetools.history.models.change

Interface AddItemShippingAddressesChange

All Superinterfaces:

Change

All Known Implementing Classes:

AddItemShippingAddressesChangeImpl

public interface AddItemShippingAddressesChange
extends Change

Change triggered by the following update actions:

• Add ItemShippingAddress on Orders.
• Add ItemShippingAddress on Staged Orders.

Example to create an instance using the builder pattern

     AddItemShippingAddressesChange addItemShippingAddressesChange = AddItemShippingAddressesChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ITEM_SHIPPING_ADDRESSES_CHANGE	discriminator value for AddItemShippingAddressesChange

Method Summary

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

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

withChange

Field Details

ADD_ITEM_SHIPPING_ADDRESSES_CHANGE

static final String ADD_ITEM_SHIPPING_ADDRESSES_CHANGE

discriminator value for AddItemShippingAddressesChange

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

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

of

static AddItemShippingAddressesChange of()

factory method

Returns:

instance of AddItemShippingAddressesChange

of

static AddItemShippingAddressesChange of(AddItemShippingAddressesChange template)

factory method to create a shallow copy AddItemShippingAddressesChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AddItemShippingAddressesChange deepCopy(@Nullable
 AddItemShippingAddressesChange template)

factory method to create a deep copy of AddItemShippingAddressesChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddItemShippingAddressesChangeBuilder builder()

builder factory method for AddItemShippingAddressesChange

Returns:

builder

builder

static AddItemShippingAddressesChangeBuilder builder(AddItemShippingAddressesChange template)

create builder for AddItemShippingAddressesChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddItemShippingAddressesChange

default <T> T withAddItemShippingAddressesChange(Function<AddItemShippingAddressesChange,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<AddItemShippingAddressesChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference