Package com.commercetools.history.models.change

Interface SetValidFromAndUntilChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetValidFromAndUntilChangeImpl

public interface SetValidFromAndUntilChange
extends Change

Change triggered by the following update actions:

• Set Valid From and Until on Cart Discounts.
• Set Valid From and Until on Discount Codes.
• Set Valid From and Until on Product Discounts.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_VALID_FROM_AND_UNTIL_CHANGE	discriminator value for SetValidFromAndUntilChange

Method Summary

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

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

withChange

Field Details

SET_VALID_FROM_AND_UNTIL_CHANGE

static final String SET_VALID_FROM_AND_UNTIL_CHANGE

discriminator value for SetValidFromAndUntilChange

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

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid ValidFromAndUntilValue 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(ValidFromAndUntilValue previousValue)

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ValidFromAndUntilValue nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetValidFromAndUntilChange of()

factory method

Returns:

instance of SetValidFromAndUntilChange

of

static SetValidFromAndUntilChange of(SetValidFromAndUntilChange template)

factory method to create a shallow copy SetValidFromAndUntilChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetValidFromAndUntilChange deepCopy(@Nullable
 SetValidFromAndUntilChange template)

factory method to create a deep copy of SetValidFromAndUntilChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetValidFromAndUntilChangeBuilder builder()

builder factory method for SetValidFromAndUntilChange

Returns:

builder

builder

static SetValidFromAndUntilChangeBuilder builder(SetValidFromAndUntilChange template)

create builder for SetValidFromAndUntilChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetValidFromAndUntilChange

default <T> T withSetValidFromAndUntilChange(Function<SetValidFromAndUntilChange,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<SetValidFromAndUntilChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference