Package com.commercetools.history.models.change

Interface SetShippingMethodChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetShippingMethodChangeImpl

public interface SetShippingMethodChange
extends Change

Change triggered by the Set ShippingMethod update action.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_METHOD_CHANGE	discriminator value for SetShippingMethodChange

Method Summary

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

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

withChange

Field Details

SET_SHIPPING_METHOD_CHANGE

static final String SET_SHIPPING_METHOD_CHANGE

discriminator value for SetShippingMethodChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ShippingMethodChangeValue nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetShippingMethodChange of()

factory method

Returns:

instance of SetShippingMethodChange

of

static SetShippingMethodChange of(SetShippingMethodChange template)

factory method to create a shallow copy SetShippingMethodChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetShippingMethodChange deepCopy(@Nullable
 SetShippingMethodChange template)

factory method to create a deep copy of SetShippingMethodChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetShippingMethodChangeBuilder builder()

builder factory method for SetShippingMethodChange

Returns:

builder

builder

static SetShippingMethodChangeBuilder builder(SetShippingMethodChange template)

create builder for SetShippingMethodChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetShippingMethodChange

default <T> T withSetShippingMethodChange(Function<SetShippingMethodChange,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<SetShippingMethodChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference