Class ReviewImpl
- All Implemented Interfaces:
BaseResource
,Customizable<Review>
,DomainResource<Review>
,Identifiable<Review>
,Referencable<Review>
,ResourceIdentifiable<Review>
,Review
,ReviewMixin
,Versioned<Review>
,WithKey
,io.vrap.rmf.base.client.ModelBase
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Name of the author.Date and time (UTC) the Review was initially created.Present on resources created after 1 February 2019 except for events not tracked.Custom Fields of the Review.Customer who created the Review.getId()
Unique identifier of the Review.Indicates if this Review is taken into account in the ratings statistics of the target.getKey()
User-defined unique identifier of the Review.Date and time (UTC) the Review was last updated.Present on resources created after 1 February 2019 except for events not tracked.Language in which the content of the Review is written.Rating of the Product or Channel.getState()
State of the Review.A Reference represents a loose reference to another resource in the same Project identified by itsid
.getText()
Content of the Review.getTitle()
Title of the Review.Must be unique among Reviews.Current version of the Review.int
hashCode()
void
setAuthorName
(String authorName) Name of the author.void
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Review was initially created.void
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) Custom Fields of the Review.void
setCustomer
(CustomerReference customer) Customer who created the Review.void
Unique identifier of the Review.void
setIncludedInStatistics
(Boolean includedInStatistics) Indicates if this Review is taken into account in the ratings statistics of the target.void
User-defined unique identifier of the Review.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Review was last updated.void
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
Language in which the content of the Review is written.void
Rating of the Product or Channel.void
setState
(StateReference state) State of the Review.void
A Reference represents a loose reference to another resource in the same Project identified by itsid
.void
Content of the Review.void
Title of the Review.void
setUniquenessValue
(String uniquenessValue) Must be unique among Reviews.void
setVersion
(Long version) Current version of the Review.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
Methods inherited from interface com.commercetools.api.models.review.Review
setTarget, withReview
Methods inherited from interface com.commercetools.api.models.review.ReviewMixin
toReference, toResourceIdentifier
-
Constructor Details
-
ReviewImpl
public ReviewImpl()create empty instance
-
-
Method Details
-
getId
Unique identifier of the Review.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<Review>
- Specified by:
getId
in interfaceIdentifiable<Review>
- Specified by:
getId
in interfaceReview
- Specified by:
getId
in interfaceVersioned<Review>
- Returns:
- id
-
getVersion
Current version of the Review.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<Review>
- Specified by:
getVersion
in interfaceReview
- Specified by:
getVersion
in interfaceVersioned<Review>
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Review was initially created.
- Specified by:
getCreatedAt
in interfaceBaseResource
- Specified by:
getCreatedAt
in interfaceReview
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Review was last updated.
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Specified by:
getLastModifiedAt
in interfaceReview
- Returns:
- lastModifiedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getLastModifiedBy
in interfaceReview
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
getCreatedBy
in interfaceReview
- Returns:
- createdBy
-
getKey
User-defined unique identifier of the Review.
-
getUniquenessValue
Must be unique among Reviews. For example, if this value is set to Customer
id
+ Productid
, only one Review per Customer and per Product is allowed.- Specified by:
getUniquenessValue
in interfaceReview
- Returns:
- uniquenessValue
-
getLocale
Language in which the content of the Review is written.
-
getAuthorName
Name of the author.
- Specified by:
getAuthorName
in interfaceReview
- Returns:
- authorName
-
getTitle
Title of the Review.
-
getText
Content of the Review.
-
getTarget
A Reference represents a loose reference to another resource in the same Project identified by its
id
. ThetypeId
indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like ChannelReference. A referenced resource can be embedded through Reference Expansion. The expanded reference is the value of an additionalobj
field then. -
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.- Specified by:
getIncludedInStatistics
in interfaceReview
- Returns:
- includedInStatistics
-
getRating
Rating of the Product or Channel.
-
getState
State of the Review. Used for approval processes, see Review approval process for details.
-
getCustomer
Customer who created the Review.
- Specified by:
getCustomer
in interfaceReview
- Returns:
- customer
-
getCustom
Custom Fields of the Review.
- Specified by:
getCustom
in interfaceCustomizable<Review>
- Specified by:
getCustom
in interfaceReview
- Returns:
- custom
-
setId
Description copied from interface:Review
Unique identifier of the Review.
- Specified by:
setId
in interfaceBaseResource
- Specified by:
setId
in interfaceReview
- Parameters:
id
- value to be set
-
setVersion
Description copied from interface:Review
Current version of the Review.
- Specified by:
setVersion
in interfaceBaseResource
- Specified by:
setVersion
in interfaceReview
- Parameters:
version
- value to be set
-
setCreatedAt
Description copied from interface:Review
Date and time (UTC) the Review was initially created.
- Specified by:
setCreatedAt
in interfaceBaseResource
- Specified by:
setCreatedAt
in interfaceReview
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Description copied from interface:Review
Date and time (UTC) the Review was last updated.
- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Specified by:
setLastModifiedAt
in interfaceReview
- Parameters:
lastModifiedAt
- value to be set
-
setLastModifiedBy
Description copied from interface:Review
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setLastModifiedBy
in interfaceReview
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Description copied from interface:Review
Present on resources created after 1 February 2019 except for events not tracked.
- Specified by:
setCreatedBy
in interfaceReview
- Parameters:
createdBy
- value to be set
-
setKey
Description copied from interface:Review
User-defined unique identifier of the Review.
-
setUniquenessValue
Description copied from interface:Review
Must be unique among Reviews. For example, if this value is set to Customer
id
+ Productid
, only one Review per Customer and per Product is allowed.- Specified by:
setUniquenessValue
in interfaceReview
- Parameters:
uniquenessValue
- value to be set
-
setLocale
Description copied from interface:Review
Language in which the content of the Review is written.
-
setAuthorName
Description copied from interface:Review
Name of the author.
- Specified by:
setAuthorName
in interfaceReview
- Parameters:
authorName
- value to be set
-
setTitle
Description copied from interface:Review
Title of the Review.
-
setText
Description copied from interface:Review
Content of the Review.
-
setTarget
Description copied from interface:Review
A Reference represents a loose reference to another resource in the same Project identified by its
id
. ThetypeId
indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like ChannelReference. A referenced resource can be embedded through Reference Expansion. The expanded reference is the value of an additionalobj
field then. -
setIncludedInStatistics
Description copied from interface:Review
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.- Specified by:
setIncludedInStatistics
in interfaceReview
- Parameters:
includedInStatistics
- value to be set
-
setRating
Description copied from interface:Review
Rating of the Product or Channel.
-
setState
Description copied from interface:Review
State of the Review. Used for approval processes, see Review approval process for details.
-
setCustomer
Description copied from interface:Review
Customer who created the Review.
- Specified by:
setCustomer
in interfaceReview
- Parameters:
customer
- value to be set
-
setCustom
Description copied from interface:Review
Custom Fields of the Review.
- Specified by:
setCustom
in interfaceCustomizable<Review>
- Specified by:
setCustom
in interfaceReview
- Parameters:
custom
- value to be set
-
equals
-
hashCode
public int hashCode()
-