Package com.commercetools.history.models.change

Interface SetAddressCustomFieldChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetAddressCustomFieldChangeImpl

public interface SetAddressCustomFieldChange
extends Change

Change triggered by the Set Address Custom Field update action.

Example to create an instance using the builder pattern

     SetAddressCustomFieldChange setAddressCustomFieldChange = SetAddressCustomFieldChange.builder()
             .change("{change}")
             .address(addressBuilder -> addressBuilder)
             .name("{name}")
             .customTypeId("{customTypeId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_FIELD_CHANGE	discriminator value for SetAddressCustomFieldChange

Method Summary

Modifier and Type	Method	Description
static SetAddressCustomFieldChangeBuilder	builder()	builder factory method for SetAddressCustomFieldChange
static SetAddressCustomFieldChangeBuilder	builder(SetAddressCustomFieldChange template)	create builder for SetAddressCustomFieldChange instance
static SetAddressCustomFieldChange	deepCopy(SetAddressCustomFieldChange template)	factory method to create a deep copy of SetAddressCustomFieldChange
@NotNull @Valid Address	getAddress()	Address which was extended.
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getCustomTypeId()	id of the referenced Type.
@NotNull String	getName()	Name of the Custom Field.
@NotNull Object	getNextValue()	Value after the change.
@NotNull Object	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static SetAddressCustomFieldChange	of()	factory method
static SetAddressCustomFieldChange	of(SetAddressCustomFieldChange template)	factory method to create a shallow copy SetAddressCustomFieldChange
void	setAddress(Address address)	Address which was extended.
void	setChange(String change)	set change
void	setCustomTypeId(String customTypeId)	id of the referenced Type.
void	setName(String name)	Name of the Custom Field.
void	setNextValue(Object nextValue)	Value after the change.
void	setPreviousValue(Object previousValue)	Value before the change.
static com.fasterxml.jackson.core.type.TypeReference<SetAddressCustomFieldChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetAddressCustomFieldChange(Function<SetAddressCustomFieldChange,T> helper)	accessor map function

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

withChange

Field Details

SET_ADDRESS_CUSTOM_FIELD_CHANGE

static final String SET_ADDRESS_CUSTOM_FIELD_CHANGE

discriminator value for SetAddressCustomFieldChange

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

getAddress

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

Address which was extended.

Returns:

address

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getCustomTypeId

@NotNull
@NotNull String getCustomTypeId()

id of the referenced Type.

Returns:

customTypeId

getPreviousValue

@NotNull
@NotNull Object getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@NotNull Object 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

setAddress

void setAddress(Address address)

Address which was extended.

Parameters:

address - value to be set

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setCustomTypeId

void setCustomTypeId(String customTypeId)

id of the referenced Type.

Parameters:

customTypeId - value to be set

setPreviousValue

void setPreviousValue(Object previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(Object nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetAddressCustomFieldChange of()

factory method

Returns:

instance of SetAddressCustomFieldChange

of

static SetAddressCustomFieldChange of(SetAddressCustomFieldChange template)

factory method to create a shallow copy SetAddressCustomFieldChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetAddressCustomFieldChange deepCopy(@Nullable
 SetAddressCustomFieldChange template)

factory method to create a deep copy of SetAddressCustomFieldChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetAddressCustomFieldChangeBuilder builder()

builder factory method for SetAddressCustomFieldChange

Returns:

builder

builder

static SetAddressCustomFieldChangeBuilder builder(SetAddressCustomFieldChange template)

create builder for SetAddressCustomFieldChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetAddressCustomFieldChange

default <T> T withSetAddressCustomFieldChange(Function<SetAddressCustomFieldChange,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<SetAddressCustomFieldChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference