@Role
public interface XWikiRecycleBinStoreInterface
Modifier and Type | Method and Description |
---|---|
default void |
deleteFromRecycleBin(long index,
XWikiContext context,
boolean bTransaction)
Permanently delete document from recycle bin.
|
void |
deleteFromRecycleBin(XWikiDocument doc,
long index,
XWikiContext context,
boolean bTransaction)
Deprecated.
since 9.4RC1. The document parameter is useless and gets in the way. Use
deleteFromRecycleBin(long, XWikiContext, boolean) instead. |
default XWikiDeletedDocument[] |
getAllDeletedDocuments(String batchId,
boolean withContent,
XWikiContext context,
boolean bTransaction) |
default XWikiDeletedDocument[] |
getAllDeletedDocuments(String batchId,
XWikiContext context,
boolean bTransaction) |
XWikiDeletedDocument[] |
getAllDeletedDocuments(XWikiDocument doc,
XWikiContext context,
boolean bTransaction) |
default Long[] |
getAllDeletedDocumentsIds(XWikiContext context,
int limit)
Get all the deleted documents ID or a specified number.
|
default XWikiDeletedDocument |
getDeletedDocument(long index,
XWikiContext context,
boolean bTransaction) |
XWikiDeletedDocument |
getDeletedDocument(XWikiDocument doc,
long index,
XWikiContext context,
boolean bTransaction)
Deprecated.
since 9.4RC1. The document parameter is useless and gets in the way. Use
getDeletedDocument(long, XWikiContext, boolean) instead. |
default Long |
getNumberOfDeletedDocuments(XWikiContext context) |
default XWikiDocument |
restoreFromRecycleBin(long index,
XWikiContext context,
boolean bTransaction) |
XWikiDocument |
restoreFromRecycleBin(XWikiDocument doc,
long index,
XWikiContext context,
boolean bTransaction)
Deprecated.
since 9.4RC1. The document parameter is useless and gets in the way. Use
restoreFromRecycleBin(long, XWikiContext, boolean) instead. |
default void |
saveToRecycleBin(XWikiDocument doc,
String deleter,
Date date,
String batchId,
XWikiContext context,
boolean bTransaction)
Save document to recycle bin.
|
void |
saveToRecycleBin(XWikiDocument doc,
String deleter,
Date date,
XWikiContext context,
boolean bTransaction)
Save document to recycle bin.
|
void saveToRecycleBin(XWikiDocument doc, String deleter, Date date, XWikiContext context, boolean bTransaction) throws XWikiException
doc
- - document to savedeleter
- - the user which delete documentdate
- - date of delete actionbTransaction
- - should use old transaction(false) or create new (true)context
- - used while savingXWikiException
- if error in savingdefault void saveToRecycleBin(XWikiDocument doc, String deleter, Date date, String batchId, XWikiContext context, boolean bTransaction) throws XWikiException
doc
- - document to savedeleter
- - the user which delete documentdate
- - date of delete actionbatchId
- - id of the operation that deleted multiple documents at the same time, useful when trying to
revert the operation. null
or empty values are ignoredbTransaction
- - should use old transaction(false) or create new (true)context
- - used while savingXWikiException
- if error in saving@Deprecated XWikiDocument restoreFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) throws XWikiException
restoreFromRecycleBin(long, XWikiContext, boolean)
instead.doc
- - document to restoreindex
- - what deleted document to restore. see XWikiDeletedDocument.getId()
context
- - used while loadingbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- if error while loadingdefault XWikiDocument restoreFromRecycleBin(long index, XWikiContext context, boolean bTransaction) throws XWikiException
index
- - what deleted document to restore. see XWikiDeletedDocument.getId()
context
- - used while loadingbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- if error while loading@Deprecated XWikiDeletedDocument getDeletedDocument(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) throws XWikiException
getDeletedDocument(long, XWikiContext, boolean)
instead.doc
- - deleted documentindex
- - what deleted document to restore. see XWikiDeletedDocument.getId()
context
- - used while loadingbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- if error while loadingdefault XWikiDeletedDocument getDeletedDocument(long index, XWikiContext context, boolean bTransaction) throws XWikiException
index
- - what deleted document to restore. See XWikiDeletedDocument.getId()
context
- - used while loadingbTransaction
- - should use old transaction(false) or create new (true)null
if not found.XWikiException
- if error while loadingXWikiDeletedDocument[] getAllDeletedDocuments(XWikiDocument doc, XWikiContext context, boolean bTransaction) throws XWikiException
doc
- - the deleted documentcontext
- - used to loadbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- - if error in loadingdefault Long[] getAllDeletedDocumentsIds(XWikiContext context, int limit) throws XWikiException
context
- - used to load the deleted documents id.limit
- - if > 0 then all deleted documents id are returned. Else the specified number.XWikiException
- - if error in loadingdefault Long getNumberOfDeletedDocuments(XWikiContext context) throws XWikiException
context
- - used to realize the query.XWikiException
- - if error in loading.default XWikiDeletedDocument[] getAllDeletedDocuments(String batchId, XWikiContext context, boolean bTransaction) throws XWikiException
batchId
- - id of the operation that deleted multiple documents at the same time; useful when trying to
revert the operationcontext
- - used to loadbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- - if error in loadingdefault XWikiDeletedDocument[] getAllDeletedDocuments(String batchId, boolean withContent, XWikiContext context, boolean bTransaction) throws XWikiException
batchId
- - id of the operation that deleted multiple documents at the same time; useful when trying to
revert the operationwithContent
- - true
if the deleted document's content should also be loaded; false
ifcontext
- - used to loadbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- - if error in loading@Deprecated void deleteFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) throws XWikiException
deleteFromRecycleBin(long, XWikiContext, boolean)
instead.doc
- - document to deleteindex
- - which instance document in recycle bin to deletecontext
- - used for environmentbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- if any errordefault void deleteFromRecycleBin(long index, XWikiContext context, boolean bTransaction) throws XWikiException
index
- - which instance document in recycle bin to deletecontext
- - used for environmentbTransaction
- - should use old transaction(false) or create new (true)XWikiException
- if any errorCopyright © 2004–2021 XWiki. All rights reserved.