Package com.commercetools.history.models.change

Interface AddShippingAddressIdChange

All Superinterfaces:

Change

All Known Implementing Classes:

AddShippingAddressIdChangeImpl

public interface AddShippingAddressIdChange
extends Change

Change triggered by the Add Shipping Address ID update action.

Example to create an instance using the builder pattern

     AddShippingAddressIdChange addShippingAddressIdChange = AddShippingAddressIdChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_SHIPPING_ADDRESS_ID_CHANGE	discriminator value for AddShippingAddressIdChange

Method Summary

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

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

withChange

Field Details

ADD_SHIPPING_ADDRESS_ID_CHANGE

static final String ADD_SHIPPING_ADDRESS_ID_CHANGE

discriminator value for AddShippingAddressIdChange

See Also:

• Constant Field Values

Method Details

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

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

getPreviousValue

@NotNull
@NotNull List<String> getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull List<String> getNextValue()

Value after the change.

Returns:

nextValue

getAddress

@NotNull
@Valid
@NotNull @Valid Address getAddress()

Address added to shippingAddressIds.

Returns:

address

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(String... previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setPreviousValue

void setPreviousValue(List<String> previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setNextValue

void setNextValue(String... nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setNextValue

void setNextValue(List<String> nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setAddress

void setAddress(Address address)

Address added to shippingAddressIds.

Parameters:

address - value to be set

of

static AddShippingAddressIdChange of()

factory method

Returns:

instance of AddShippingAddressIdChange

of

static AddShippingAddressIdChange of(AddShippingAddressIdChange template)

factory method to create a shallow copy AddShippingAddressIdChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AddShippingAddressIdChange deepCopy(@Nullable
 AddShippingAddressIdChange template)

factory method to create a deep copy of AddShippingAddressIdChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddShippingAddressIdChangeBuilder builder()

builder factory method for AddShippingAddressIdChange

Returns:

builder

builder

static AddShippingAddressIdChangeBuilder builder(AddShippingAddressIdChange template)

create builder for AddShippingAddressIdChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddShippingAddressIdChange

default <T> T withAddShippingAddressIdChange(Function<AddShippingAddressIdChange,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<AddShippingAddressIdChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference