1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.extension.repository.rating

File Ratable.java

 

Code metrics

0
0
0
1
57
11
0
-
-
0
-

Classes

Class Line # Actions
Ratable 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.extension.repository.rating;
21   
22    import org.xwiki.extension.ExtensionId;
23    import org.xwiki.extension.ResolveException;
24    import org.xwiki.extension.rating.ExtensionRating;
25    import org.xwiki.extension.version.Version;
26   
27    /**
28    * A repository can implement it to provide rating capabilities.
29    *
30    * @version $Id: 069f5df4e5a3b2eb2f68e9841052fc8a72c5dee5 $
31    * @since 6.4M3
32    */
 
33    public interface Ratable
34    {
35    /**
36    * @param extensionId the extension id
37    * @return the total votes/average vote pair representing an extension's rating
38    * @throws ResolveException error when trying to resolve extension for provided extensionId
39    */
40    ExtensionRating getRating(ExtensionId extensionId) throws ResolveException;
41   
42    /**
43    * @param extensionId the extension id
44    * @param extensionVersion the extension version
45    * @return the total votes/average vote pair representing an extension's rating
46    * @throws ResolveException error when trying to resolve extension for provided extensionId
47    */
48    ExtensionRating getRating(String extensionId, Version extensionVersion) throws ResolveException;
49   
50    /**
51    * @param extensionId the extension id
52    * @param extensionVersion the extension version
53    * @return the total votes/average vote pair representing an extension's rating
54    * @throws ResolveException error when trying to resolve extension for provided extensionId
55    */
56    ExtensionRating getRating(String extensionId, String extensionVersion) throws ResolveException;
57    }