org.xwiki.ratings

Interface Rating

@Unstable
public interface Rating

Generic interface of what should be available in a Rating.

Since:

12.9RC1

Version:

$Id: 0aa2846587a9a75b309f2d124fb7d341affad3d5 $

Method Summary

Modifier and Type	Method and Description
org.xwiki.user.UserReference	getAuthor()
Date	getCreatedAt()
String	getId()
String	getManagerId()
org.xwiki.model.reference.EntityReference	getReference()
int	getScaleUpperBound()
Date	getUpdatedAt()
int	getVote()

Method Detail

getId

String getId()

Returns:

the identifier of this rating data.

getManagerId

String getManagerId()

Returns:

the identifier of the manager who handles this data.

getReference

org.xwiki.model.reference.EntityReference getReference()

Returns:

the reference of the element being graded.

getAuthor

org.xwiki.user.UserReference getAuthor()

Returns:

the reference of the user who performs the rating.

getCreatedAt

Date getCreatedAt()

Returns:

the date of the creation of this rating data.

getUpdatedAt

Date getUpdatedAt()

Returns:

the date of the last update of this rating data. It could be same as getCreatedAt() if no update has been performed.

getVote

int getVote()

Returns:

the actual rating.

getScaleUpperBound

int getScaleUpperBound()

Returns:

the upper bound of the scale used to rate.