com.commercetools.api.models.review

Interface Review

All Superinterfaces:

BaseResource, DomainResource<Review>

All Known Implementing Classes:

ReviewImpl

public interface Review
extends BaseResource, DomainResource<Review>

Method Summary

Modifier and Type	Method and Description
static ReviewBuilder	builder()
static ReviewBuilder	builder(Review template)
String	getAuthorName()
@NotNull ZonedDateTime	getCreatedAt()
@Valid CreatedBy	getCreatedBy() Present on resources created after 1/02/2019 except for events not tracked.
@Valid CustomFields	getCustom()
@Valid CustomerReference	getCustomer() The customer who created the review.
@NotNull String	getId() The unique ID of the review.
@NotNull Boolean	getIncludedInStatistics() Indicates if this review is taken into account in the ratings statistics of the target.
String	getKey() User-specific unique identifier for the review.
@NotNull ZonedDateTime	getLastModifiedAt()
@Valid LastModifiedBy	getLastModifiedBy() Present on resources updated after 1/02/2019 except for events not tracked.
String	getLocale()
Integer	getRating() Number between -100 and 100 included.
@Valid StateReference	getState()
Object	getTarget() Identifies the target of the review.
String	getText()
String	getTitle()
String	getUniquenessValue()
@NotNull Long	getVersion() The current version of the review.
static Review	of()
static Review	of(Review template)
void	setAuthorName(String authorName)
void	setCreatedAt(ZonedDateTime createdAt)
void	setCreatedBy(CreatedBy createdBy)
void	setCustom(CustomFields custom)
void	setCustomer(CustomerReference customer)
void	setId(String id)
void	setIncludedInStatistics(Boolean includedInStatistics)
void	setKey(String key)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)
void	setLocale(String locale)
void	setRating(Integer rating)
void	setState(StateReference state)
void	setTarget(ChannelReference target)
void	setTarget(Object target)
void	setTarget(ProductReference target)
void	setText(String text)
void	setTitle(String title)
void	setUniquenessValue(String uniquenessValue)
void	setVersion(Long version)
default <T> T	withReview(Function<Review,T> helper)

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

Method Detail

getId

@NotNull
@NotNull String getId()

The unique ID of the review.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<Review>

getVersion

@NotNull
@NotNull Long getVersion()

The current version of the review.

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<Review>

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface BaseResource

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Specified by:

getLastModifiedAt in interface BaseResource

getLastModifiedBy

@Valid
@Valid LastModifiedBy getLastModifiedBy()

Present on resources updated after 1/02/2019 except for events not tracked.

getCreatedBy

@Valid
@Valid CreatedBy getCreatedBy()

Present on resources created after 1/02/2019 except for events not tracked.

getKey

String getKey()

User-specific unique identifier for the review.

getUniquenessValue

String getUniquenessValue()

getLocale

String getLocale()

getAuthorName

String getAuthorName()

getTitle

String getTitle()

getText

String getText()

getTarget

Object getTarget()

Identifies the target of the review. Can be a Product or a Channel

getIncludedInStatistics

@NotNull
@NotNull Boolean getIncludedInStatistics()

Indicates if this review is taken into account in the ratings statistics of the target. A review is per default used in the statistics, unless the review is in a state that does not have the role ReviewIncludedInStatistics. If the role of a State is modified after the calculation of this field, the calculation is not updated.

getRating

Integer getRating()

Number between -100 and 100 included.

getState

@Valid
@Valid StateReference getState()

getCustomer

@Valid
@Valid CustomerReference getCustomer()

The customer who created the review.

getCustom

@Valid
@Valid CustomFields getCustom()

setId

void setId(String id)

Specified by:

setId in interface BaseResource

setVersion

void setVersion(Long version)

Specified by:

setVersion in interface BaseResource

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

Specified by:

setCreatedAt in interface BaseResource

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Specified by:

setLastModifiedAt in interface BaseResource

setLastModifiedBy

void setLastModifiedBy(LastModifiedBy lastModifiedBy)

setCreatedBy

void setCreatedBy(CreatedBy createdBy)

setKey

void setKey(String key)

setUniquenessValue

void setUniquenessValue(String uniquenessValue)

setLocale

void setLocale(String locale)

setAuthorName

void setAuthorName(String authorName)

setTitle

void setTitle(String title)

setText

void setText(String text)

setTarget

void setTarget(ProductReference target)

setTarget

void setTarget(ChannelReference target)

setTarget

void setTarget(Object target)

setIncludedInStatistics

void setIncludedInStatistics(Boolean includedInStatistics)

setRating

void setRating(Integer rating)

setState

void setState(StateReference state)

setCustomer

void setCustomer(CustomerReference customer)

setCustom

void setCustom(CustomFields custom)

of

static Review of()

of

static Review of(Review template)

builder

static ReviewBuilder builder()

builder

static ReviewBuilder builder(Review template)

withReview

default <T> T withReview(Function<Review,T> helper)