Package com.commercetools.history.models.change

Interface SetCustomShippingMethodChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetCustomShippingMethodChangeImpl

public interface SetCustomShippingMethodChange
extends Change

Change triggered by the Set Custom ShippingMethod update action.

Example to create an instance using the builder pattern

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_SHIPPING_METHOD_CHANGE	discriminator value for SetCustomShippingMethodChange

Method Summary

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

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

withChange

Field Details

SET_CUSTOM_SHIPPING_METHOD_CHANGE

static final String SET_CUSTOM_SHIPPING_METHOD_CHANGE

discriminator value for SetCustomShippingMethodChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(CustomShippingMethodChangeValue nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetCustomShippingMethodChange of()

factory method

Returns:

instance of SetCustomShippingMethodChange

of

static SetCustomShippingMethodChange of(SetCustomShippingMethodChange template)

factory method to create a shallow copy SetCustomShippingMethodChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetCustomShippingMethodChange deepCopy(@Nullable
 SetCustomShippingMethodChange template)

factory method to create a deep copy of SetCustomShippingMethodChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetCustomShippingMethodChangeBuilder builder()

builder factory method for SetCustomShippingMethodChange

Returns:

builder

builder

static SetCustomShippingMethodChangeBuilder builder(SetCustomShippingMethodChange template)

create builder for SetCustomShippingMethodChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetCustomShippingMethodChange

default <T> T withSetCustomShippingMethodChange(Function<SetCustomShippingMethodChange,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<SetCustomShippingMethodChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference