Package com.commercetools.history.models.change

Interface TransitionLineItemStateChange

All Superinterfaces:

Change

All Known Implementing Classes:

TransitionLineItemStateChangeImpl

public interface TransitionLineItemStateChange
extends Change

Change triggered by the following update actions:

• Change the state of LineItem according to allowed transitions on Orders.
• Change the state of LineItem according to allowed transitions on Staged Orders.

Example to create an instance using the builder pattern

     TransitionLineItemStateChange transitionLineItemStateChange = TransitionLineItemStateChange.builder()
             .change("{change}")
             .plusPreviousValue(previousValueBuilder -> previousValueBuilder)
             .plusNextValue(nextValueBuilder -> nextValueBuilder)
             .lineItemId("{lineItemId}")
             .stateId("{stateId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSITION_LINE_ITEM_STATE_CHANGE	discriminator value for TransitionLineItemStateChange

Method Summary

Modifier and Type	Method	Description
static TransitionLineItemStateChangeBuilder	builder()	builder factory method for TransitionLineItemStateChange
static TransitionLineItemStateChangeBuilder	builder(TransitionLineItemStateChange template)	create builder for TransitionLineItemStateChange instance
static TransitionLineItemStateChange	deepCopy(TransitionLineItemStateChange template)	factory method to create a deep copy of TransitionLineItemStateChange
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull String	getLineItemId()	id of the updated LineItem.
@NotNull @Valid List<ItemState>	getNextValue()	Value after the change.
@NotNull @Valid List<ItemState>	getPreviousValue()	Value before the change.
@NotNull String	getStateId()	id of the State involved in the transition.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static TransitionLineItemStateChange	of()	factory method
static TransitionLineItemStateChange	of(TransitionLineItemStateChange template)	factory method to create a shallow copy TransitionLineItemStateChange
void	setChange(String change)	set change
void	setLineItemId(String lineItemId)	id of the updated LineItem.
void	setNextValue(ItemState... nextValue)	Value after the change.
void	setNextValue(List<ItemState> nextValue)	Value after the change.
void	setPreviousValue(ItemState... previousValue)	Value before the change.
void	setPreviousValue(List<ItemState> previousValue)	Value before the change.
void	setStateId(String stateId)	id of the State involved in the transition.
static com.fasterxml.jackson.core.type.TypeReference<TransitionLineItemStateChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTransitionLineItemStateChange(Function<TransitionLineItemStateChange,T> helper)	accessor map function

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

withChange

Field Details

TRANSITION_LINE_ITEM_STATE_CHANGE

static final String TRANSITION_LINE_ITEM_STATE_CHANGE

discriminator value for TransitionLineItemStateChange

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 List<ItemState> getPreviousValue()

Value before the change.

Returns:

previousValue

getNextValue

@NotNull
@Valid
@NotNull @Valid List<ItemState> getNextValue()

Value after the change.

Returns:

nextValue

getLineItemId

@NotNull
@NotNull String getLineItemId()

id of the updated LineItem.

Returns:

lineItemId

getStateId

@NotNull
@NotNull String getStateId()

id of the State involved in the transition.

Returns:

stateId

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(ItemState... previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setPreviousValue

void setPreviousValue(List<ItemState> previousValue)

Value before the change.

Parameters:

previousValue - values to be set

setNextValue

void setNextValue(ItemState... nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setNextValue

void setNextValue(List<ItemState> nextValue)

Value after the change.

Parameters:

nextValue - values to be set

setLineItemId

void setLineItemId(String lineItemId)

id of the updated LineItem.

Parameters:

lineItemId - value to be set

setStateId

void setStateId(String stateId)

id of the State involved in the transition.

Parameters:

stateId - value to be set

of

static TransitionLineItemStateChange of()

factory method

Returns:

instance of TransitionLineItemStateChange

of

static TransitionLineItemStateChange of(TransitionLineItemStateChange template)

factory method to create a shallow copy TransitionLineItemStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static TransitionLineItemStateChange deepCopy(@Nullable
 TransitionLineItemStateChange template)

factory method to create a deep copy of TransitionLineItemStateChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TransitionLineItemStateChangeBuilder builder()

builder factory method for TransitionLineItemStateChange

Returns:

builder

builder

static TransitionLineItemStateChangeBuilder builder(TransitionLineItemStateChange template)

create builder for TransitionLineItemStateChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTransitionLineItemStateChange

default <T> T withTransitionLineItemStateChange(Function<TransitionLineItemStateChange,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<TransitionLineItemStateChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference