Package com.xpn.xwiki.store

Interface XWikiVersioningStoreInterface

All Known Implementing Classes:

XWikiHibernateVersioningStore

@Role
public interface XWikiVersioningStoreInterface

Interface for manipulate document history.

Version:

$Id: 9c89a758dc5309b27f90c0f9005a5ab75a318132 $

Method Summary

Modifier and Type	Method	Description
void	deleteArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)	Delete all history for a document.
XWikiDocumentArchive	getXWikiDocumentArchive(XWikiDocument doc, XWikiContext context)
org.suigeneris.jrcs.rcs.Version[]	getXWikiDocVersions(XWikiDocument doc, XWikiContext context)
XWikiRCSNodeContent	loadRCSNodeContent(XWikiRCSNodeId id, boolean bTransaction, XWikiContext context)	Load XWikiRCSNodeContent on demand.
XWikiDocument	loadXWikiDoc(XWikiDocument doc, String version, XWikiContext context)
void	loadXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
void	resetRCSArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)
void	saveXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
void	updateXWikiDocArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)

Method Detail

loadXWikiDocArchive

void loadXWikiDocArchive(XWikiDocumentArchive archivedoc,
                         boolean bTransaction,
                         XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

saveXWikiDocArchive

void saveXWikiDocArchive(XWikiDocumentArchive archivedoc,
                         boolean bTransaction,
                         XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

updateXWikiDocArchive

void updateXWikiDocArchive(XWikiDocument doc,
                           boolean bTransaction,
                           XWikiContext context)
                    throws XWikiException

Throws:

XWikiException

getXWikiDocVersions

org.suigeneris.jrcs.rcs.Version[] getXWikiDocVersions(XWikiDocument doc,
                                                      XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

loadXWikiDoc

XWikiDocument loadXWikiDoc(XWikiDocument doc,
                           String version,
                           XWikiContext context)
                    throws XWikiException

Throws:

XWikiException

resetRCSArchive

void resetRCSArchive(XWikiDocument doc,
                     boolean bTransaction,
                     XWikiContext context)
              throws XWikiException

Throws:

XWikiException

getXWikiDocumentArchive

XWikiDocumentArchive getXWikiDocumentArchive(XWikiDocument doc,
                                             XWikiContext context)
                                      throws XWikiException

Throws:

XWikiException

deleteArchive

void deleteArchive(XWikiDocument doc,
                   boolean bTransaction,
                   XWikiContext context)
            throws XWikiException

Delete all history for a document.

Parameters:

doc - the document for which to delete all the history

Throws:

XWikiException

loadRCSNodeContent

XWikiRCSNodeContent loadRCSNodeContent(XWikiRCSNodeId id,
                                       boolean bTransaction,
                                       XWikiContext context)
                                throws XWikiException

Load XWikiRCSNodeContent on demand. Used in XWikiRCSNodeInfo.getContent(XWikiContext) for example.

Parameters:

id - the node id (see XWikiRCSNodeContent.getId())

Returns:

the RCS node content for the passed node id

Throws:

XWikiException