org.odpi.openmetadata.frameworks.connectors.properties.beans

Class Rating

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Rating

All Implemented Interfaces:

Serializable

public class Rating
extends ElementHeader

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isPublic
protected String	review
protected StarRating	starRating
protected String	user

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
Rating() Default constructor
Rating(Rating template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getReview() Return the review comments - null means no review is available.
StarRating	getStarRating() Return the stars for the rating.
String	getUser() Return the user id of the person who created the rating.
boolean	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	setReview(String review) Set up the review comments - null means no review is available.
void	setStarRating(StarRating starRating) Set up the stars for the rating.
void	setUser(String user) Set up the user id of the person who created the rating.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, hashCode, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

starRating

protected StarRating starRating

review

protected String review

user

protected String user

isPublic

protected boolean isPublic

Constructor Detail

Rating

public Rating()

Default constructor

Rating

public Rating(Rating template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getUser

public String getUser()

Return the user id of the person who created the rating. Null means the user id is not known.

Returns:

String user

setUser

public void setUser(String user)

Set up the user id of the person who created the rating. Null means the user id is not known.

Parameters:

user - string

getStarRating

public StarRating getStarRating()

Return the stars for the rating.

Returns:

StarRating enum

setStarRating

public void setStarRating(StarRating starRating)

Set up the stars for the rating.

Parameters:

starRating - StarRating enum

getReview

public String getReview()

Return the review comments - null means no review is available.

Returns:

String review comments

setReview

public void setReview(String review)

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

public String toString()

Standard toString method.

Overrides:

toString in class ElementHeader

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class ElementHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison