Package com.commercetools.api.models.product

Interface ProductUpdate

All Superinterfaces:

ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

public interface ProductUpdate
extends ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

ProductUpdate Example to create an instance using the builder pattern

     ProductUpdate productUpdate = ProductUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ProductUpdateBuilder	builder()	builder factory method for ProductUpdate
static ProductUpdateBuilder	builder(ProductUpdate template)	create builder for ProductUpdate instance
ProductUpdate	copyDeep()
static ProductUpdate	deepCopy(ProductUpdate template)	factory method to create a deep copy of ProductUpdate
@NotNull @Valid List<ProductUpdateAction>	getActions()	Update actions to be performed on the Product.
@NotNull Long	getVersion()	Expected version of the Product on which the changes should be applied.
static ProductUpdate	of()	factory method
static ProductUpdate	of(ProductUpdate template)	factory method to create a shallow copy ProductUpdate
void	setActions(ProductUpdateAction... actions)	Update actions to be performed on the Product.
void	setActions(List<ProductUpdateAction> actions)	Update actions to be performed on the Product.
void	setVersion(Long version)	Expected version of the Product on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<ProductUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductUpdate(Function<ProductUpdate,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdate

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the Product on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

getVersion in interface ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<ProductUpdateAction> getActions()

Update actions to be performed on the Product.

Specified by:

getActions in interface ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Product on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

setVersion in interface ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ProductUpdateAction... actions)

Update actions to be performed on the Product.

Parameters:

actions - values to be set

setActions

void setActions(List<ProductUpdateAction> actions)

Update actions to be performed on the Product.

Specified by:

setActions in interface ResourceUpdate<ProductUpdate,ProductUpdateAction,ProductUpdateBuilder>

Parameters:

actions - values to be set

of

static ProductUpdate of()

factory method

Returns:

instance of ProductUpdate

of

static ProductUpdate of(ProductUpdate template)

factory method to create a shallow copy ProductUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductUpdate copyDeep()

deepCopy

@Nullable
static ProductUpdate deepCopy(@Nullable
 ProductUpdate template)

factory method to create a deep copy of ProductUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductUpdateBuilder builder()

builder factory method for ProductUpdate

Returns:

builder

builder

static ProductUpdateBuilder builder(ProductUpdate template)

create builder for ProductUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductUpdate

default <T> T withProductUpdate(Function<ProductUpdate,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<ProductUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference