Package org.alfresco.service.cmr.rating

Class Rating

java.lang.Object

org.alfresco.service.cmr.rating.Rating

public class Rating
extends java.lang.Object

This struct class holds the essential data of a rating.

Since:

3.4

Author:

Neil McErlean

Constructor Summary

Constructors

Constructor	Description
Rating(RatingScheme scheme, float score, java.lang.String appliedBy, java.util.Date appliedAt)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getAppliedAt()	Gets the time/date at which the rating was applied.
java.lang.String	getAppliedBy()	Gets the user name of the user who applied this rating.
RatingScheme	getScheme()	Gets the RatingScheme under which the rating was applied.
float	getScore()	Gets the score applied as part of this rating.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rating

public Rating(RatingScheme scheme,
              float score,
              java.lang.String appliedBy,
              java.util.Date appliedAt)

Method Detail

getScore

public float getScore()

Gets the score applied as part of this rating. In normal circumstances a score should always lie within the bounds defined by the RatingScheme.

Returns:

the score.

getAppliedBy

public java.lang.String getAppliedBy()

Gets the user name of the user who applied this rating.

Returns:

the user who applied the rating.

getAppliedAt

public java.util.Date getAppliedAt()

Gets the time/date at which the rating was applied.

Returns:

the date/time at which the rating was applied.

getScheme

public RatingScheme getScheme()

Gets the RatingScheme under which the rating was applied.

Returns:

the rating scheme used for this rating.