com.xpn.xwiki.doc
Class XWikiDeletedDocument
java.lang.Object
com.xpn.xwiki.util.AbstractSimpleClass
com.xpn.xwiki.doc.XWikiDeletedDocument
public class XWikiDeletedDocument
- extends AbstractSimpleClass
Archive of deleted document, stored in XWikiRecycleBinStoreInterface
Immutable, because
we don't need modify deleted document.
- Since:
- 1.2M1
- Version:
- $Id: 0e679950a805790d4fadf215fd9ee894a6dfc982 $
XWikiDeletedDocument
protected XWikiDeletedDocument()
- Default constructor. Used only in hibernate.
XWikiDeletedDocument
public XWikiDeletedDocument(XWikiDocument doc,
String deleter,
Date deleteDate,
XWikiContext context)
throws XWikiException
- Parameters:
doc
- - deleted documentdeleter
- - user which delete documentdeleteDate
- - date of delete actioncontext
- - used for environment
- Throws:
XWikiException
- if any error
getId
public long getId()
- Returns:
- the synthetic id of this deleted document. unique only for document.
setId
protected void setId(long id)
- Parameters:
id
- - the synthetic id to set. used only in hibernate.
getFullName
public String getFullName()
- Returns:
XWikiDocument.getFullName()
setFullName
protected void setFullName(String docFullName)
- Parameters:
docFullName
- - XWikiDocument.getFullName()
to set
getLanguage
public String getLanguage()
- Returns:
XWikiDocument.getLanguage()
setLanguage
protected void setLanguage(String language)
- Parameters:
language
- - XWikiDocument.getLanguage()
to set
getDate
public Date getDate()
- Returns:
- the date of delete action
setDate
protected void setDate(Date date)
- Parameters:
date
- - the date of delete action to set
getDeleter
public String getDeleter()
- Returns:
- the user which has removed the document
setDeleter
protected void setDeleter(String deleter)
- Parameters:
deleter
- - the user which has removed the document to set
getXml
public String getXml()
- Returns:
- xml serialization of
XWikiDocument
setXml
protected void setXml(String xml)
- Parameters:
xml
- - xml serialization of XWikiDocument
setDocument
protected void setDocument(XWikiDocument doc,
XWikiContext context)
throws XWikiException
- export
XWikiDocument
to XWikiDeletedDocument
.
- Parameters:
doc
- - deleted documentcontext
- - used in XWikiDocument.toXML(XWikiContext)
- Throws:
XWikiException
- in error in XWikiDocument.toXML(XWikiContext)
restoreDocument
public XWikiDocument restoreDocument(XWikiDocument doc,
XWikiContext context)
throws XWikiException
- Parameters:
doc
- - restore to this document, if not nullcontext
- - may be useful in future
- Returns:
- restored document
- Throws:
XWikiException
- if error in XWikiDocument.fromXML(String)
Copyright © 2004-2013 XWiki. All Rights Reserved.