Package com.commercetools.api.models.review

Interface ReviewUpdate

All Superinterfaces:

ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

public interface ReviewUpdate
extends ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

ReviewUpdate Example to create an instance using the builder pattern

     ReviewUpdate reviewUpdate = ReviewUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

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

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

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

The expected version of the review on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

Specified by:

getVersion in interface ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

Returns:

version

getActions

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

The list of update actions to be performed on the review.

Specified by:

getActions in interface ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

The expected version of the review on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

Specified by:

setVersion in interface ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(ReviewUpdateAction... actions)

The list of update actions to be performed on the review.

Parameters:

actions - values to be set

setActions

void setActions(List<ReviewUpdateAction> actions)

The list of update actions to be performed on the review.

Specified by:

setActions in interface ResourceUpdate<ReviewUpdate,ReviewUpdateAction,ReviewUpdateBuilder>

Parameters:

actions - values to be set

of

static ReviewUpdate of()

factory method

Returns:

instance of ReviewUpdate

of

static ReviewUpdate of(ReviewUpdate template)

factory method to create a shallow copy ReviewUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ReviewUpdate copyDeep()

deepCopy

@Nullable
static ReviewUpdate deepCopy(@Nullable
 ReviewUpdate template)

factory method to create a deep copy of ReviewUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ReviewUpdateBuilder builder()

builder factory method for ReviewUpdate

Returns:

builder

builder

static ReviewUpdateBuilder builder(ReviewUpdate template)

create builder for ReviewUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withReviewUpdate

default <T> T withReviewUpdate(Function<ReviewUpdate,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<ReviewUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference