Package com.commercetools.history.models.change

Interface ChangeShipmentStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

ChangeShipmentStateChangeImpl

public interface ChangeShipmentStateChange
extends Change

Change triggered by the following update actions:

• Change ShipmentState on Orders.
• Change ShipmentState on Staged Orders.

Example to create an instance using the builder pattern

     ChangeShipmentStateChange changeShipmentStateChange = ChangeShipmentStateChange.builder()
             .change("{change}")
             .previousValue(ShipmentState.SHIPPED)
             .nextValue(ShipmentState.SHIPPED)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_SHIPMENT_STATE_CHANGE	discriminator value for ChangeShipmentStateChange

Method Summary

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

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

withChange

Field Details

CHANGE_SHIPMENT_STATE_CHANGE

static final String CHANGE_SHIPMENT_STATE_CHANGE

discriminator value for ChangeShipmentStateChange

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
@NotNull ShipmentState getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(ShipmentState nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static ChangeShipmentStateChange of()

factory method

Returns:

instance of ChangeShipmentStateChange

of

static ChangeShipmentStateChange of(ChangeShipmentStateChange template)

factory method to create a shallow copy ChangeShipmentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeShipmentStateChange deepCopy(@Nullable
 ChangeShipmentStateChange template)

factory method to create a deep copy of ChangeShipmentStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeShipmentStateChangeBuilder builder()

builder factory method for ChangeShipmentStateChange

Returns:

builder

builder

static ChangeShipmentStateChangeBuilder builder(ChangeShipmentStateChange template)

create builder for ChangeShipmentStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeShipmentStateChange

default <T> T withChangeShipmentStateChange(Function<ChangeShipmentStateChange,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<ChangeShipmentStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference