Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Interface Rating

All Known Implementing Classes:
DbRating

public interface Rating

A container object for Ratings. A rating is a flexible way for a user to rate forum messages.

Since:
4.0
See Also:
RatingManager

Method Summary
 boolean equals(Rating rating)
          Test for equality between two rating objects.
 java.lang.String getDescription()
          Retrieve the description for the rating.
 int getScore()
          Retrieve the score for the rating.
 

Method Detail

getScore

int getScore()
Retrieve the score for the rating.

Returns:
the score associated with the Rating object.

getDescription

java.lang.String getDescription()
Retrieve the description for the rating.

Returns:
the description associated with the Rating object.

equals

boolean equals(Rating rating)
Test for equality between two rating objects.

Parameters:
rating - the Rating object to test for equality.
Returns:
true if equal, false otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.