Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ConfiguredProvider | 34 | 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 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.model.reference.DocumentReference; | |
24 | ||
25 | /** | |
26 | * Provide instances of objects configured relative to the passed document. | |
27 | * | |
28 | * @param <T> the type of the returned object | |
29 | * @version $Id: eef519854c067c76cd023b62bb218caa3e276b9a $ | |
30 | * @since 6.4M3 | |
31 | */ | |
32 | @Role | |
33 | //TODO: replace this system by a default component dynamically taking into account the configuration behind the scene | |
34 | public interface ConfiguredProvider<T> | |
35 | { | |
36 | /** | |
37 | * Returns an instance of a component based on the current configuration. | |
38 | * | |
39 | * @param documentRef the document to which the ratings are associated to | |
40 | * @return an instance of RatingsManager (default or separate) | |
41 | */ | |
42 | T get(DocumentReference documentRef); | |
43 | } |