Class RatingProperties
java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.properties.RatingProperties
RatingProperties stores information about a rating connected to an asset. Ratings provide informal feedback on the quality of assets
and can be added at any time.
Ratings have the userId of the person who added it, a star rating and an optional review comment.
The content of the rating is a personal judgement (which is why the user's id is in the object)
and there is no formal review of the ratings. However, they can be used as a basis for crowd-sourcing
feedback to asset owners.
-
Constructor Summary
ConstructorDescriptionDefault constructorRatingProperties
(RatingProperties template) Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the review comments - null means no review is available.Return the stars for the rating.getUser()
Return the user id of the person who created the rating.int
hashCode()
Return hash code for this objectboolean
isPublic()
Return if this rating is private ot the creating user.void
setPublic
(boolean aPublic) Set up whether the rating is private to the creating user or not.void
Set up the review comments - null means no review is available.void
setStarRating
(StarRating starRating) Set up the stars for the rating.void
Set up the user id of the person who created the rating.toString()
Standard toString method.
-
Constructor Details
-
RatingProperties
public RatingProperties()Default constructor -
RatingProperties
Copy/clone constructor.- Parameters:
template
- element to copy
-
-
Method Details
-
getUser
Return the user id of the person who created the rating. Null means the user id is not known.- Returns:
- String user
-
setUser
Set up the user id of the person who created the rating. Null means the user id is not known.- Parameters:
user
- string
-
getStarRating
Return the stars for the rating.- Returns:
- StarRating enum
-
setStarRating
Set up the stars for the rating.- Parameters:
starRating
- StarRating enum
-
getReview
Return the review comments - null means no review is available.- Returns:
- String review comments
-
setReview
Set up the review comments - null means no review is available.- Parameters:
review
- String review comments
-
isPublic
public boolean isPublic()Return if this rating is private ot the creating user.- Returns:
- boolean
-
setPublic
public void setPublic(boolean aPublic) Set up whether the rating is private to the creating user or not.- Parameters:
aPublic
- boolean
-
toString
Standard toString method. -
equals
Compare the values of the supplied object with those stored in the current object. -
hashCode
public int hashCode()Return hash code for this object
-