Package com.commercetools.history.models.change

Interface SetShippingAddressChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetShippingAddressChangeImpl

public interface SetShippingAddressChange
extends Change

Change triggered by the following update actions:

• Set Shipping Address on Orders.
• Set Shipping Address on Staged Orders.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_CHANGE	discriminator value for SetShippingAddressChange

Method Summary

Modifier and Type	Method	Description
static SetShippingAddressChangeBuilder	builder()	builder factory method for SetShippingAddressChange
static SetShippingAddressChangeBuilder	builder(SetShippingAddressChange template)	create builder for SetShippingAddressChange instance
static SetShippingAddressChange	deepCopy(SetShippingAddressChange template)	factory method to create a deep copy of SetShippingAddressChange
@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 SetShippingAddressChange	of()	factory method
static SetShippingAddressChange	of(SetShippingAddressChange template)	factory method to create a shallow copy SetShippingAddressChange
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<SetShippingAddressChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetShippingAddressChange(Function<SetShippingAddressChange,T> helper)	accessor map function

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

withChange

Field Details

SET_SHIPPING_ADDRESS_CHANGE

static final String SET_SHIPPING_ADDRESS_CHANGE

discriminator value for SetShippingAddressChange

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 SetShippingAddressChange of()

factory method

Returns:

instance of SetShippingAddressChange

of

static SetShippingAddressChange of(SetShippingAddressChange template)

factory method to create a shallow copy SetShippingAddressChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetShippingAddressChange deepCopy(@Nullable
 SetShippingAddressChange template)

factory method to create a deep copy of SetShippingAddressChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetShippingAddressChangeBuilder builder()

builder factory method for SetShippingAddressChange

Returns:

builder

builder

static SetShippingAddressChangeBuilder builder(SetShippingAddressChange template)

create builder for SetShippingAddressChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetShippingAddressChange

default <T> T withSetShippingAddressChange(Function<SetShippingAddressChange,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<SetShippingAddressChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference