Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|

AverageRating | 28 | 0 | - | 0 | 0 |

1 | /* | |

2 | * See the NOTICE file distributed with this work for additional | |

3 | * information regarding copyright ownership. | |

4 | * | |

5 | * This is free software; you can redistribute it and/or modify it | |

6 | * under the terms of the GNU Lesser General Public License as | |

7 | * published by the Free Software Foundation; either version 2.1 of | |

8 | * the License, or (at your option) any later version. | |

9 | * | |

10 | * This software is distributed in the hope that it will be useful, | |

11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |

12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |

13 | * Lesser General Public License for more details. | |

14 | * | |

15 | * You should have received a copy of the GNU Lesser General Public | |

16 | * License along with this software; if not, write to the Free | |

17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |

18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |

19 | */ | |

20 | package org.xwiki.ratings; | |

21 | ||

22 | /** | |

23 | * Represents a computed average rating for a container or a set of containers. | |

24 | * | |

25 | * @version $Id: 8ac4cbdbd1b6bbbb5d16bd2b5d692f7b276fb97a $ | |

26 | * @since 6.4M3 | |

27 | */ | |

28 | public interface AverageRating | |

29 | { | |

30 | /** | |

31 | * Gets the number of votes. | |

32 | * | |

33 | * @return the number of votes for the container this average rating represents | |

34 | */ | |

35 | int getNbVotes(); | |

36 | ||

37 | /** | |

38 | * Sets the number of votes for the container this average rating represents. | |

39 | * | |

40 | * @param nbVotes the total number of votes for the container represented by this average rating | |

41 | */ | |

42 | void setNbVotes(int nbVotes); | |

43 | ||

44 | /** | |

45 | * Gets the average vote. | |

46 | * | |

47 | * @return the average vote for this container. | |

48 | */ | |

49 | float getAverageVote(); | |

50 | ||

51 | /** | |

52 | * Sets the average vote. | |

53 | * | |

54 | * @param averageVote the average vote | |

55 | */ | |

56 | void setAverageVote(float averageVote); | |

57 | ||

58 | /** | |

59 | * Gets the method used to compute the average rating. | |

60 | * | |

61 | * @return the method used to compute the average rating | |

62 | */ | |

63 | String getMethod(); | |

64 | ||

65 | /** | |

66 | * Sets the method used to compute the average rating. | |

67 | * | |

68 | * @param method the method used to compute the average rating | |

69 | */ | |

70 | void setMethod(String method); | |

71 | ||

72 | /** | |

73 | * Saves this average rating. | |

74 | * | |

75 | * @throws RatingsException when an error occurs while saving this average rating | |

76 | */ | |

77 | void save() throws RatingsException; | |

78 | } |