Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
RatingsConfiguration	36	0	-	0	0	-1.0 -	Show methods

Class RatingsConfiguration

Class RatingsConfiguration	Line # 36	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

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.ratings;
21
22		import org.xwiki.component.annotation.Role;
23		import org.xwiki.model.reference.DocumentReference;
24		import org.xwiki.stability.Unstable;
25
26		import com.xpn.xwiki.doc.XWikiDocument;
27
28		/**
29		* Provides Ratings configuration.
30		*
31		* @version $Id: 7cd014b291008786d50d979bc242b50b2ae461a8 $
32		* @since 8.2.1
33		*/
34		@Role
35		@Unstable
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
36		public interface RatingsConfiguration
37		{
38		/**
39		* @param documentReference the documentReference for which to return the configuration document
40		* @return the configuration document
41		*/
42		XWikiDocument getConfigurationDocument(DocumentReference documentReference);
43
44		/**
45		* Retrieves configuration parameter from the current space's WebPreferences and fallback to XWiki.RatingsConfig if
46		* it does not exist.
47		*
48		* @param documentReference the document being rated or for which the existing ratings are fetched
49		* @param parameterName the parameter for which to retrieve the value
50		* @param defaultValue the default value for the parameter
51		* @return the value of the given parameter name from the current configuration context
52		*/
53		String getConfigurationParameter(DocumentReference documentReference, String parameterName, String defaultValue);
54		}