Package com.xpn.xwiki.store

Interface XWikiRecycleBinContentStoreInterface

@Role
public interface XWikiRecycleBinContentStoreInterface

Store the content of a deleted document.

Since:

9.0RC1

Version:

$Id: c1a7ef3a3bb35cea7d162d100c94bd8cd37a3ddb $

Method Summary

Modifier and Type	Method	Description
void	delete(DocumentReference reference, long index, boolean bTransaction)	Permanently delete document content from recycle bin.
XWikiDeletedDocumentContent	get(DocumentReference reference, long index, boolean bTransaction)
String	getHint()
void	save(XWikiDocument doc, long index, boolean bTransaction)	Save document to recycle bin.

Method Detail

getHint

String getHint()

Returns:

the hint of the component

save

void save(XWikiDocument doc,
          long index,
          boolean bTransaction)
   throws XWikiException

Save document to recycle bin.

Parameters:

doc - the document to save

index - the index of the deleted document

bTransaction - indicate if the store should use old transaction(false) or create new (true)

Throws:

XWikiException - if error in saving

get

XWikiDeletedDocumentContent get(DocumentReference reference,
                                long index,
                                boolean bTransaction)
                         throws XWikiException

Parameters:

reference - the reference of the deleted document

index - the index of the deleted document

bTransaction - indicate if the store should use old transaction(false) or create new (true)

Returns:

specified deleted document from recycle bin. null if not found.

Throws:

XWikiException - if error while loading

delete

void delete(DocumentReference reference,
            long index,
            boolean bTransaction)
     throws XWikiException

Permanently delete document content from recycle bin.

Parameters:

reference - the reference of the deleted document

index - the index of the deleted document

bTransaction - indicate if the store should use old transaction(false) or create new (true)

Throws:

XWikiException - if any error