Package com.commercetools.history.models.change

Interface SetPurchaseOrderNumberChange

All Superinterfaces:

Change

All Known Implementing Classes:

SetPurchaseOrderNumberChangeImpl

public interface SetPurchaseOrderNumberChange
extends Change

Change triggered by the following update actions:

• Set Purchase Order Number on Orders.
• Set Purchase Order Number on Staged Orders.

Example to create an instance using the builder pattern

     SetPurchaseOrderNumberChange setPurchaseOrderNumberChange = SetPurchaseOrderNumberChange.builder()
             .change("{change}")
             .previousValue("{previousValue}")
             .nextValue("{nextValue}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_PURCHASE_ORDER_NUMBER_CHANGE	discriminator value for SetPurchaseOrderNumberChange

Method Summary

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

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

withChange

Field Details

SET_PURCHASE_ORDER_NUMBER_CHANGE

static final String SET_PURCHASE_ORDER_NUMBER_CHANGE

discriminator value for SetPurchaseOrderNumberChange

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

Value before the change.

Returns:

previousValue

getNextValue

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

Value before the change.

Parameters:

previousValue - value to be set

setNextValue

void setNextValue(String nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static SetPurchaseOrderNumberChange of()

factory method

Returns:

instance of SetPurchaseOrderNumberChange

of

static SetPurchaseOrderNumberChange of(SetPurchaseOrderNumberChange template)

factory method to create a shallow copy SetPurchaseOrderNumberChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SetPurchaseOrderNumberChange deepCopy(@Nullable
 SetPurchaseOrderNumberChange template)

factory method to create a deep copy of SetPurchaseOrderNumberChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SetPurchaseOrderNumberChangeBuilder builder()

builder factory method for SetPurchaseOrderNumberChange

Returns:

builder

builder

static SetPurchaseOrderNumberChangeBuilder builder(SetPurchaseOrderNumberChange template)

create builder for SetPurchaseOrderNumberChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSetPurchaseOrderNumberChange

default <T> T withSetPurchaseOrderNumberChange(Function<SetPurchaseOrderNumberChange,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<SetPurchaseOrderNumberChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference