Classes

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

Class XWikiVersioningStoreInterface

Class XWikiVersioningStoreInterface	Line # 38	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 com.xpn.xwiki.store;
21
22		import org.suigeneris.jrcs.rcs.Version;
23		import org.xwiki.component.annotation.Role;
24
25		import com.xpn.xwiki.XWikiContext;
26		import com.xpn.xwiki.XWikiException;
27		import com.xpn.xwiki.doc.XWikiDocument;
28		import com.xpn.xwiki.doc.XWikiDocumentArchive;
29		import com.xpn.xwiki.doc.rcs.XWikiRCSNodeContent;
30		import com.xpn.xwiki.doc.rcs.XWikiRCSNodeId;
31
32		/**
33		* Interface for manipulate document history.
34		*
35		* @version $Id: 9c89a758dc5309b27f90c0f9005a5ab75a318132 $
36		*/
37		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
38		public interface XWikiVersioningStoreInterface
39		{
40		void loadXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
41		throws XWikiException;
42
43		void saveXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
44		throws XWikiException;
45
46		void updateXWikiDocArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context) throws XWikiException;
47
48		Version[] getXWikiDocVersions(XWikiDocument doc, XWikiContext context) throws XWikiException;
49
50		XWikiDocument loadXWikiDoc(XWikiDocument doc, String version, XWikiContext context) throws XWikiException;
51
52		void resetRCSArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context) throws XWikiException;
53
54		XWikiDocumentArchive getXWikiDocumentArchive(XWikiDocument doc, XWikiContext context) throws XWikiException;
55
56		/**
57		* Delete all history for a document.
58		*
59		* @param doc the document for which to delete all the history
60		*/
61		void deleteArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context) throws XWikiException;
62
63		/**
64		* Load {@link XWikiRCSNodeContent} on demand. Used in
65		* {@link com.xpn.xwiki.doc.rcs.XWikiRCSNodeInfo#getContent(XWikiContext)} for example.
66		*
67		* @return the RCS node content for the passed node id
68		* @param id the node id (see {@link XWikiRCSNodeContent#getId()})
69		*/
70		XWikiRCSNodeContent loadRCSNodeContent(XWikiRCSNodeId id, boolean bTransaction, XWikiContext context)
71		throws XWikiException;
72		}