Package com.commercetools.history.models.change

Interface SetVariantAvailabilityChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetVariantAvailabilityChangeImpl

public interface SetVariantAvailabilityChange
extends Change

Change triggered automatically when an InventoryEntry associated with a Product changes.

Example to create an instance using the builder pattern

     SetVariantAvailabilityChange setVariantAvailabilityChange = SetVariantAvailabilityChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .catalogData("{catalogData}")
             .variant("{variant}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_VARIANT_AVAILABILITY_CHANGE	discriminator value for SetVariantAvailabilityChange

Method Summary

Modifier and Type	Method	Description
static SetVariantAvailabilityChangeBuilder	builder()	builder factory method for SetVariantAvailabilityChange
static SetVariantAvailabilityChangeBuilder	builder(SetVariantAvailabilityChange template)	create builder for SetVariantAvailabilityChange instance
static SetVariantAvailabilityChange	deepCopy(SetVariantAvailabilityChange template)	factory method to create a deep copy of SetVariantAvailabilityChange
@NotNull String	getCatalogData()	staged, if the staged ProductCatalogData was updated. current, if the current ProductCatalogData was updated.
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid ProductVariantAvailability	getNextValue()	Value after the change.
@NotNull @Valid ProductVariantAvailability	getPreviousValue()	Value before the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
@NotNull String	getVariant()	sku or key of the ProductVariant.
static SetVariantAvailabilityChange	of()	factory method
static SetVariantAvailabilityChange	of(SetVariantAvailabilityChange template)	factory method to create a shallow copy SetVariantAvailabilityChange
void	setCatalogData(String catalogData)	staged, if the staged ProductCatalogData was updated. current, if the current ProductCatalogData was updated.
void	setChange(String change)	set change
void	setNextValue(ProductVariantAvailability nextValue)	Value after the change.
void	setPreviousValue(ProductVariantAvailability previousValue)	Value before the change.
void	setVariant(String variant)	sku or key of the ProductVariant.
static com.fasterxml.jackson.core.type.TypeReference<SetVariantAvailabilityChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSetVariantAvailabilityChange(Function<SetVariantAvailabilityChange,T> helper)	accessor map function

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

withChange

Field Details

SET_VARIANT_AVAILABILITY_CHANGE

static final String SET_VARIANT_AVAILABILITY_CHANGE

discriminator value for SetVariantAvailabilityChange

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

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid ProductVariantAvailability getNextValue()

Value after the change.

Returns:

nextValue

getCatalogData

@NotNull
@NotNull String getCatalogData()

• staged, if the staged ProductCatalogData was updated.
• current, if the current ProductCatalogData was updated.

Returns:

catalogData

getVariant

@NotNull
@NotNull String getVariant()

sku or key of the ProductVariant.

Returns:

variant

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(ProductVariantAvailability previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ProductVariantAvailability nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setCatalogData

void setCatalogData(String catalogData)

• staged, if the staged ProductCatalogData was updated.
• current, if the current ProductCatalogData was updated.

Parameters:

catalogData - value to be set

setVariant

void setVariant(String variant)

sku or key of the ProductVariant.

Parameters:

variant - value to be set

of

static SetVariantAvailabilityChange of()

factory method

Returns:

instance of SetVariantAvailabilityChange

of

static SetVariantAvailabilityChange of(SetVariantAvailabilityChange template)

factory method to create a shallow copy SetVariantAvailabilityChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetVariantAvailabilityChange deepCopy(@Nullable
 SetVariantAvailabilityChange template)

factory method to create a deep copy of SetVariantAvailabilityChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetVariantAvailabilityChangeBuilder builder()

builder factory method for SetVariantAvailabilityChange

Returns:

builder

builder

static SetVariantAvailabilityChangeBuilder builder(SetVariantAvailabilityChange template)

create builder for SetVariantAvailabilityChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetVariantAvailabilityChange

default <T> T withSetVariantAvailabilityChange(Function<SetVariantAvailabilityChange,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<SetVariantAvailabilityChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference