Uses of Class
com.xpn.xwiki.doc.XWikiDocument

Packages that use XWikiDocument

Package	Description
com.xpn.xwiki
com.xpn.xwiki.api
com.xpn.xwiki.doc
com.xpn.xwiki.doc.rcs
com.xpn.xwiki.job
com.xpn.xwiki.objects
com.xpn.xwiki.objects.classes
com.xpn.xwiki.pdf.api
com.xpn.xwiki.pdf.impl
com.xpn.xwiki.plugin.packaging
com.xpn.xwiki.plugin.rightsmanager
com.xpn.xwiki.stats.impl.xwiki
com.xpn.xwiki.store
com.xpn.xwiki.store.hibernate
com.xpn.xwiki.user.api
com.xpn.xwiki.user.impl.xwiki
com.xpn.xwiki.validation
com.xpn.xwiki.web

Uses of XWikiDocument in com.xpn.xwiki

Methods in com.xpn.xwiki that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	XWikiContext.getDoc()
XWikiDocument	XWiki.getDocument(DocumentReference reference, String revision, XWikiContext context) Deprecated. sine 9.10RC1, use DocumentRevisionProvider.getRevision(DocumentReference, String) instead
XWikiDocument	XWiki.getDocument(DocumentReference reference, XWikiContext context)
XWikiDocument	XWiki.getDocument(EntityReference reference, XWikiContext context) Loads a XWikiDocument from the store.
XWikiDocument	XWiki.getDocument(PageReference reference, XWikiContext context)
XWikiDocument	XWiki.getDocument(String reference, EntityType type, XWikiContext xcontext) Loads a XWikiDocument from the store.
XWikiDocument	XWiki.getDocument(String spaces, String fullname, XWikiContext context) Deprecated. since 2.2M1 use XWiki.getDocument(DocumentReference, XWikiContext) instead
XWikiDocument	XWiki.getDocument(String fullname, XWikiContext context) Deprecated. since 2.2M1 use XWiki.getDocument(DocumentReference, XWikiContext) instead
XWikiDocument	XWiki.getDocument(XWikiDocument document, String revision, XWikiContext context) Deprecated. sine 9.10RC1, use DocumentRevisionProvider.getRevision(XWikiDocument, String) instead
XWikiDocument	XWiki.getDocument(XWikiDocument doc, XWikiContext context)
XWikiDocument	XWikiContext.getWikiServer()
XWikiDocument	XWiki.rollback(XWikiDocument tdoc, String rev, boolean addRevision, XWikiContext xcontext)
XWikiDocument	XWiki.rollback(XWikiDocument tdoc, String rev, XWikiContext context)

Methods in com.xpn.xwiki with parameters of type XWikiDocument

Modifier and Type	Method and Description
boolean	XWiki.checkAccess(String action, XWikiDocument doc, XWikiContext context)
void	XWiki.checkDeletingDocument(DocumentReference userReference, XWikiDocument document, XWikiContext context) Check if the user is allowed to delete the document.
void	XWiki.checkSavingDocument(DocumentReference userReference, XWikiDocument document, String comment, boolean isMinorEdit, XWikiContext context) Check if the user is allowed to save the document.
void	XWiki.checkSavingDocument(DocumentReference userReference, XWikiDocument document, String comment, XWikiContext context) Check if the user is allowed to save the document.
void	XWiki.checkSavingDocument(DocumentReference userReference, XWikiDocument document, XWikiContext context) Check if the user is allowed to save the document.
void	XWiki.deleteAllDocuments(XWikiDocument doc, boolean toTrash, XWikiContext context)
void	XWiki.deleteAllDocuments(XWikiDocument doc, XWikiContext context)
void	XWiki.deleteDocument(XWikiDocument doc, boolean totrash, XWikiContext context)
void	XWiki.deleteDocument(XWikiDocument doc, XWikiContext context)
XWikiDocument	XWiki.getDocument(XWikiDocument document, String revision, XWikiContext context) Deprecated. sine 9.10RC1, use DocumentRevisionProvider.getRevision(XWikiDocument, String) instead
XWikiDocument	XWiki.getDocument(XWikiDocument doc, XWikiContext context)
void	XWiki.protectUserPage(String userName, String userRights, XWikiDocument doc, XWikiContext context)
void	XWiki.renameByCopyAndDelete(XWikiDocument sourceDoc, DocumentReference newDocumentReference, List<DocumentReference> backlinkDocumentReferences, List<DocumentReference> childDocumentReferences, XWikiContext context) Deprecated. Old implementation of the rename by copy and delete. Since 12.5 the implementation using XWikiStoreInterface.renameXWikiDoc(XWikiDocument, DocumentReference, XWikiContext) should be preferred.
void	XWiki.restoreFromRecycleBin(XWikiDocument doc, long index, String comment, XWikiContext context) Deprecated. since 9.4RC1. Use XWiki.restoreFromRecycleBin(long, String, XWikiContext) instead.
void	XWiki.restoreFromRecycleBin(XWikiDocument doc, String comment, XWikiContext context) Restore a document with passed index from recycle bin.
XWikiDocument	XWiki.rollback(XWikiDocument tdoc, String rev, boolean addRevision, XWikiContext xcontext)
XWikiDocument	XWiki.rollback(XWikiDocument tdoc, String rev, XWikiContext context)
void	XWiki.saveDocument(XWikiDocument document, String comment, boolean isMinorEdit, XWikiContext context) Save the passed document in the store.
void	XWiki.saveDocument(XWikiDocument doc, String comment, XWikiContext context)
void	XWiki.saveDocument(XWikiDocument doc, XWikiContext context)
void	XWikiContext.setDoc(XWikiDocument doc)
boolean	XWiki.validateDocument(XWikiDocument doc, XWikiContext context)

Uses of XWikiDocument in com.xpn.xwiki.api

Fields in com.xpn.xwiki.api declared as XWikiDocument

Modifier and Type	Field and Description
protected XWikiDocument	Document.doc The XWikiDocument object wrapped by this API.
protected XWikiDocument	Document.initialDoc The XWikiDocument object wrapped by this API.

Methods in com.xpn.xwiki.api that return XWikiDocument

Modifier and Type	Method and Description
protected XWikiDocument	Document.getDoc() Get a clone of the XWikiDocument wrapped by this API.
XWikiDocument	Context.getDoc() Returns the current requested document.
XWikiDocument	Document.getDocument() Get the XWikiDocument wrapped by this API.

Methods in com.xpn.xwiki.api with parameters of type XWikiDocument

Modifier and Type	Method and Description
protected Document	Api.convert(XWikiDocument xdoc) Convert an internal representation of document to public api document.
boolean	Document.same(XWikiDocument document) Check if the passed one is the one wrapped by this Document.
void	Context.setDoc(XWikiDocument doc) Sets the current document.

Method parameters in com.xpn.xwiki.api with type arguments of type XWikiDocument

Modifier and Type	Method and Description
protected List<Document>	Api.convert(List<XWikiDocument> xdocList) Convert a list of internal representation of documents to public api documents.

Constructors in com.xpn.xwiki.api with parameters of type XWikiDocument

Constructor and Description
Document(XWikiDocument doc, XWikiContext context) Document constructor.

Uses of XWikiDocument in com.xpn.xwiki.doc

Subclasses of XWikiDocument in com.xpn.xwiki.doc

Modifier and Type	Class and Description
class	LazyXWikiDocument Read only lazy loading document.

Methods in com.xpn.xwiki.doc that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	XWikiDocument.clone()
XWikiDocument	XWikiDocument.cloneRename(DocumentReference newDocumentReference, XWikiContext context) Clone a document and change its reference.
XWikiDocument	XWikiDocument.copyDocument(DocumentReference newDocumentReference, XWikiContext context)
XWikiDocument	XWikiDocument.copyDocument(String newDocumentName, XWikiContext context) Deprecated. since 2.2M1 use copyDocument(DocumentReference, XWikiContext) instead
XWikiDocument	XWikiDocument.duplicate(DocumentReference newDocumentReference) Duplicate this document and give it a new name.
XWikiDocument	XWikiAttachment.getDoc()
XWikiDocument	XWikiDocument.getOriginalDocument()
XWikiDocument	XWikiDocument.getParentDoc() Deprecated. since 2.2M1 use getParentReference() instead
XWikiDocument	DocumentRevisionProvider.getRevision(DocumentReference reference, String revision) Load the document in the provided revision.
XWikiDocument	DocumentRevisionProvider.getRevision(XWikiDocument document, String revision) Load the document in the provided revision.
XWikiDocument	XWikiDocument.getTranslatedDocument(Locale locale, XWikiContext context) Return the document in the provided language.
XWikiDocument	XWikiDocument.getTranslatedDocument(String language, XWikiContext context) Deprecated. since 4.3M2 use getTranslatedDocument(Locale, XWikiContext) insead
XWikiDocument	XWikiDocument.getTranslatedDocument(XWikiContext context)
XWikiDocument	XWikiDeletedDocumentContent.getXWikiDocument(XWikiDocument document)
XWikiDocument	XWikiDocumentArchive.loadDocument(org.suigeneris.jrcs.rcs.Version version, XWikiContext context)
XWikiDocument	XWikiDeletedDocument.restoreDocument(XWikiContext context)
XWikiDocument	XWikiDeletedDocument.restoreDocument(XWikiDocument doc, XWikiContext context)

Methods in com.xpn.xwiki.doc with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	XWikiDocument.addXObjectsToRemoveFromVersion(XWikiDocument previousVersion) Automatically add objects present in the old version, but not in the current document, to the list of objects marked for removal from the database.
boolean	XWikiDocument.apply(XWikiDocument document) Apply modification comming from provided document.
boolean	XWikiDocument.apply(XWikiDocument document, boolean clean) Apply modification comming from provided document.
void	XWikiDocument.clone(XWikiDocument document) Use the document passed as parameter as the new identity for the current document.
void	XWikiDocument.cloneXObjects(XWikiDocument templatedoc)
void	XWikiDocument.copyAttachments(XWikiDocument sourceDocument) Copy attachments from one document to another.
void	XWikiDocument.duplicateXObjects(XWikiDocument templatedoc)
boolean	XWikiDocument.equalsData(XWikiDocument otherDocument) Same as equals(Object) but only for actual datas of the document.
List<AttachmentDiff>	XWikiDocument.getAttachmentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
List<List<ObjectDiff>>	XWikiDocument.getClassDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
List<org.suigeneris.jrcs.diff.delta.Delta>	XWikiDocument.getContentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
List<MetaDataDiff>	XWikiDocument.getMetaDataDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
List<List<ObjectDiff>>	XWikiDocument.getObjectDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context) Return the object differences between two document versions.
String	XWikiDocument.getRenderedContent(String text, String syntaxId, boolean restrictedTransformationContext, XWikiDocument sDocument, XWikiContext context)
String	XWikiDocument.getRenderedContent(String text, String sourceSyntaxId, String targetSyntaxId, boolean restrictedTransformationContext, XWikiDocument sDocument, XWikiContext context)
List<org.suigeneris.jrcs.diff.delta.Delta>	XWikiDocument.getRenderedContentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
XWikiDocument	DocumentRevisionProvider.getRevision(XWikiDocument document, String revision) Load the document in the provided revision.
List<org.suigeneris.jrcs.diff.delta.Delta>	XWikiDocument.getXMLDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
XWikiDocument	XWikiDeletedDocumentContent.getXWikiDocument(XWikiDocument document)
protected XWikiRCSNodeContent	XWikiDocumentArchive.makePatch(XWikiRCSNodeInfo newnode, XWikiDocument doc, XWikiContext context) Make a patch.
MergeResult	XWikiDocument.merge(XWikiDocument previousDocument, XWikiDocument newDocument, MergeConfiguration configuration, XWikiContext context) Deprecated. Starting with 11.8RC1 use MergeManager.mergeDocument(DocumentModelBridge, DocumentModelBridge, DocumentModelBridge, MergeConfiguration).
void	XWikiDocument.mergeXClass(XWikiDocument templatedoc)
void	XWikiDocument.mergeXObjects(XWikiDocument templateDoc)
void	XWikiDocument.mergexWikiClass(XWikiDocument templatedoc) Deprecated. since 2.2M1 use mergeXClass(XWikiDocument) instead
void	XWikiDocument.mergexWikiObjects(XWikiDocument templatedoc) Deprecated. since 2.2M1 use mergeXObjects(XWikiDocument) instead
XWikiDocument	XWikiDeletedDocument.restoreDocument(XWikiDocument doc, XWikiContext context)
void	XWikiAttachment.setDoc(XWikiDocument doc)
void	XWikiAttachment.setDoc(XWikiDocument doc, boolean updateDirty)
protected void	XWikiDeletedDocument.setDocument(XWikiDocument doc, XWikiContext context) Deprecated. since 9.0RC1, use instead
void	XWikiDocument.setOriginalDocument(XWikiDocument originalDocument)
void	XWikiAttachmentContent.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document in order to propagate the content dirty flag.
void	XWikiDocumentArchive.updateArchive(XWikiDocument doc, String author, Date date, String comment, org.suigeneris.jrcs.rcs.Version version, XWikiContext context) Update history with new document version.
protected boolean	AbstractMandatoryClassInitializer.updateClassDocumentFields(XWikiDocument document) Update document with standard class related properties.
boolean	MandatoryDocumentInitializer.updateDocument(XWikiDocument document) Update the provided document according to the need.
boolean	AbstractMandatoryDocumentInitializer.updateDocument(XWikiDocument document)
boolean	AbstractMandatoryClassInitializer.updateDocument(XWikiDocument document)
protected boolean	AbstractMandatoryDocumentInitializer.updateDocumentFields(XWikiDocument document, String title) Set the fields of the document passed as parameter.
protected boolean	AbstractMandatoryClassInitializer.updateDocumentSheet(XWikiDocument document) Update document sheet.
protected boolean	AbstractMandatoryDocumentInitializer.updateTitle(XWikiDocument document)

Constructors in com.xpn.xwiki.doc with parameters of type XWikiDocument

Constructor and Description
XWikiAttachment(XWikiDocument doc, String filename)
XWikiDeletedDocument(XWikiDocument doc, String deleter, Date deleteDate, XWikiContext context)

Uses of XWikiDocument in com.xpn.xwiki.doc.rcs

Methods in com.xpn.xwiki.doc.rcs with parameters of type XWikiDocument

Modifier and Type	Method and Description
XWikiPatch	XWikiPatch.setDiffVersion(String originalVersionXml, XWikiDocument newVersion, XWikiContext context) Create history patch between originalVersion and newVersion as difference on the XML export of the two versions.
XWikiPatch	XWikiPatch.setDiffVersion(XWikiDocument originalVersion, XWikiDocument newVersion, XWikiContext context) Create history patch between originalVersion and newVersion as difference on the XML export of the two versions.
XWikiPatch	XWikiPatch.setFullVersion(XWikiDocument version, XWikiContext context) Store the XML export of the document as the history patch; this will be a history milestone.

Uses of XWikiDocument in com.xpn.xwiki.job

Methods in com.xpn.xwiki.job that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	JobRequestContext.getDocument() Deprecated.
XWikiDocument	JobRequestContext.getSDocument() Deprecated.

Methods in com.xpn.xwiki.job with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	JobRequestContext.setDocument(XWikiDocument document) Deprecated.
void	JobRequestContext.setSDocument(XWikiDocument sdocument) Deprecated.

Uses of XWikiDocument in com.xpn.xwiki.objects

Fields in com.xpn.xwiki.objects declared as XWikiDocument

Modifier and Type	Field and Description
protected XWikiDocument	BaseElement.ownerDocument The owner document, if this element was obtained from a document.

Methods in com.xpn.xwiki.objects that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	BaseElement.getOwnerDocument()

Methods in com.xpn.xwiki.objects with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	BaseElement.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document of this element.
void	BaseCollection.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document of this base object.
void	BaseProperty.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document of this base property.
void	BaseObject.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document of this base object.

Uses of XWikiDocument in com.xpn.xwiki.objects.classes

Methods in com.xpn.xwiki.objects.classes with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	BaseClass.setOwnerDocument(XWikiDocument ownerDocument) Set the owner document of this base property.

Uses of XWikiDocument in com.xpn.xwiki.pdf.api

Methods in com.xpn.xwiki.pdf.api with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	PdfExport.export(XWikiDocument doc, OutputStream out, PdfExport.ExportType type, XWikiContext context) Export a wiki Document into PDF or RTF.
void	PdfExport.exportToPDF(XWikiDocument doc, OutputStream out, XWikiContext context) Export a wiki Document into PDF.

Uses of XWikiDocument in com.xpn.xwiki.pdf.impl

Methods in com.xpn.xwiki.pdf.impl with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	PdfExportImpl.export(XWikiDocument doc, OutputStream out, PdfExport.ExportType type, XWikiContext context)
void	PdfExportImpl.exportToPDF(XWikiDocument doc, OutputStream out, XWikiContext context)

Uses of XWikiDocument in com.xpn.xwiki.plugin.packaging

Methods in com.xpn.xwiki.plugin.packaging that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	DocumentInfo.getDoc() Deprecated.

Methods in com.xpn.xwiki.plugin.packaging with parameters of type XWikiDocument

Modifier and Type	Method and Description
boolean	Package.add(XWikiDocument doc, int defaultAction, XWikiContext context) Deprecated.
boolean	Package.add(XWikiDocument doc, XWikiContext context) Deprecated.
void	Package.addToDir(XWikiDocument doc, File dir, boolean withVersions, XWikiContext context) Deprecated.
void	Package.addToZip(XWikiDocument doc, ZipOutputStream zos, boolean withVersions, XWikiContext context) Deprecated. since 4.1M2
void	Package.filter(XWikiDocument doc, XWikiContext context) Deprecated.
void	DocumentFilter.filter(XWikiDocument doc, XWikiContext context) Deprecated. Do actions at the import or export on a document.
String	Package.getDirectoryForDocument(XWikiDocument doc) Deprecated. Generate a relative path based on provided document for the directory where the document should be stored.
String	Package.getFileNameFromDocument(XWikiDocument doc, XWikiContext context) Deprecated. Generate a file name based on provided document.
String	Package.getPathFromDocument(XWikiDocument doc, XWikiContext context) Deprecated. Generate a relative path based on provided document.
void	DocumentInfo.setDoc(XWikiDocument doc) Deprecated.

Constructors in com.xpn.xwiki.plugin.packaging with parameters of type XWikiDocument

Constructor and Description
DocumentInfo(XWikiDocument doc) Deprecated.

Uses of XWikiDocument in com.xpn.xwiki.plugin.rightsmanager

Methods in com.xpn.xwiki.plugin.rightsmanager that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	RightsManager.getParentPreference(String spaceOrPage, XWikiContext context) Get the document containing inherited rights of provided document.
XWikiDocument	RightsManager.getParentPreference(XWikiDocument currentPreference, boolean currentGlobal, XWikiContext context) Get the document containing inherited rights of provided document.

Methods in com.xpn.xwiki.plugin.rightsmanager with parameters of type XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	RightsManager.getParentPreference(XWikiDocument currentPreference, boolean currentGlobal, XWikiContext context) Get the document containing inherited rights of provided document.
boolean	RightsManager.removeUserOrGroupFromAllRights(XWikiDocument rightsDocument, String userOrGroupWiki, String userOrGroupSpace, String userOrGroupName, boolean user, XWikiContext context) Remove all references to provided user or group from provided rights document.
boolean	RightsManager.removeUserOrGroupFromRights(XWikiDocument rightsDocument, String userOrGroupWiki, String userOrGroupSpace, String userOrGroupName, boolean user, boolean global, XWikiContext context) Remove all references to provided user or group from provided rights document.

Uses of XWikiDocument in com.xpn.xwiki.stats.impl.xwiki

Methods in com.xpn.xwiki.stats.impl.xwiki with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	XWikiStatsStoreService.addStats(XWikiDocument doc, String action, XWikiContext context) Add all the statistics to the save queue.

Uses of XWikiDocument in com.xpn.xwiki.store

Methods in com.xpn.xwiki.store that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	XWikiHibernateVersioningStore.loadXWikiDoc(XWikiDocument basedoc, String sversion, XWikiContext inputxcontext)
XWikiDocument	XWikiVersioningStoreInterface.loadXWikiDoc(XWikiDocument doc, String version, XWikiContext context)
XWikiDocument	XWikiStoreInterface.loadXWikiDoc(XWikiDocument doc, XWikiContext context)
XWikiDocument	XWikiCacheStore.loadXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
XWikiDocument	XWikiHibernateStore.loadXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
XWikiDocument	XWikiHibernateRecycleBinStore.restoreFromRecycleBin(long index, XWikiContext inputxcontext, boolean bTransaction)
default XWikiDocument	XWikiRecycleBinStoreInterface.restoreFromRecycleBin(long index, XWikiContext context, boolean bTransaction)
XWikiDocument	XWikiHibernateRecycleBinStore.restoreFromRecycleBin(XWikiDocument doc, long index, XWikiContext inputxcontext, boolean bTransaction)
XWikiDocument	XWikiRecycleBinStoreInterface.restoreFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) Deprecated. since 9.4RC1. The document parameter is useless and gets in the way. Use XWikiRecycleBinStoreInterface.restoreFromRecycleBin(long, XWikiContext, boolean) instead.

Methods in com.xpn.xwiki.store that return types with arguments of type XWikiDocument

Modifier and Type	Method and Description
org.xwiki.cache.Cache<XWikiDocument>	XWikiCacheStore.getCache()
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, boolean checkRight, int nb, int start, List<?> parameterValues, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, boolean checkRight, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, boolean checkRight, int nb, int start, List<?> parameterValues, XWikiContext inputxcontext)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, boolean checkRight, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbyname, boolean customMapping, boolean checkRight, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, boolean checkRight, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, int nb, int start, List<?> parameterValues, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, boolean distinctbyname, boolean customMapping, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbyname, boolean customMapping, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbyname, boolean customMapping, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, boolean customMapping, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start, List<?> parameterValues, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, boolean distinctbyname, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbyname, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, boolean distinctbylanguage, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, boolean distinctbylanguage, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, boolean distinctbyname, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, boolean distinctbylanguage, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, int nb, int start, List<?> parameterValues, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, int nb, int start, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, int nb, int start, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, int nb, int start, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, List<?> parameterValues, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, List<?> parameterValues, XWikiContext context)
List<XWikiDocument>	XWikiStoreInterface.searchDocuments(String wheresql, XWikiContext context) Search documents in the storing system.
List<XWikiDocument>	XWikiDefaultStore.searchDocuments(String wheresql, XWikiContext context)
List<XWikiDocument>	XWikiCacheStore.searchDocuments(String wheresql, XWikiContext context)
List<XWikiDocument>	XWikiHibernateStore.searchDocuments(String wheresql, XWikiContext context)

Methods in com.xpn.xwiki.store with parameters of type XWikiDocument

Modifier and Type	Method and Description
void	XWikiHibernateVersioningStore.deleteArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)
void	XWikiVersioningStoreInterface.deleteArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context) Delete all history for a document.
void	XWikiHibernateRecycleBinStore.deleteFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction)
void	XWikiRecycleBinStoreInterface.deleteFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) Deprecated. since 9.4RC1. The document parameter is useless and gets in the way. Use XWikiRecycleBinStoreInterface.deleteFromRecycleBin(long, XWikiContext, boolean) instead.
void	XWikiStoreInterface.deleteXWikiDoc(XWikiDocument doc, XWikiContext context)
void	XWikiCacheStore.deleteXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
void	XWikiHibernateStore.deleteXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
boolean	XWikiStoreInterface.exists(XWikiDocument doc, XWikiContext context)
boolean	XWikiCacheStore.exists(XWikiDocument doc, XWikiContext inputxcontext)
boolean	XWikiHibernateStore.exists(XWikiDocument doc, XWikiContext inputxcontext) Verifies if a wiki document exists
List<DeletedAttachment>	AttachmentRecycleBinStore.getAllDeletedAttachments(XWikiDocument doc, XWikiContext context, boolean bTransaction) Get all the deleted attachments for a given document.
XWikiDeletedDocument[]	XWikiHibernateRecycleBinStore.getAllDeletedDocuments(XWikiDocument doc, XWikiContext context, boolean bTransaction)
XWikiDeletedDocument[]	XWikiRecycleBinStoreInterface.getAllDeletedDocuments(XWikiDocument doc, XWikiContext context, boolean bTransaction)
void	XWikiHibernateStore.getContent(XWikiDocument doc, StringBuffer buf)
XWikiDeletedDocument	XWikiHibernateRecycleBinStore.getDeletedDocument(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction)
XWikiDeletedDocument	XWikiRecycleBinStoreInterface.getDeletedDocument(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) Deprecated. since 9.4RC1. The document parameter is useless and gets in the way. Use XWikiRecycleBinStoreInterface.getDeletedDocument(long, XWikiContext, boolean) instead.
String	XWikiCacheStore.getKey(XWikiDocument doc) Deprecated. since 4.0M1, use getKey()
String	XWikiCacheStore.getKey(XWikiDocument doc, XWikiContext context)
List<String>	XWikiStoreInterface.getTranslationList(XWikiDocument doc, XWikiContext context)
List<String>	XWikiCacheStore.getTranslationList(XWikiDocument doc, XWikiContext context)
List<String>	XWikiHibernateStore.getTranslationList(XWikiDocument doc, XWikiContext context)
XWikiDocumentArchive	XWikiHibernateVersioningStore.getXWikiDocumentArchive(XWikiDocument doc, XWikiContext inputxcontext)
XWikiDocumentArchive	XWikiVersioningStoreInterface.getXWikiDocumentArchive(XWikiDocument doc, XWikiContext context)
org.suigeneris.jrcs.rcs.Version[]	XWikiHibernateVersioningStore.getXWikiDocVersions(XWikiDocument doc, XWikiContext context)
org.suigeneris.jrcs.rcs.Version[]	XWikiVersioningStoreInterface.getXWikiDocVersions(XWikiDocument doc, XWikiContext context)
boolean	XWikiStoreInterface.injectCustomMappings(XWikiDocument doc, XWikiContext context)
boolean	XWikiDefaultStore.injectCustomMappings(XWikiDocument doc, XWikiContext xWikiContext)
boolean	XWikiCacheStore.injectCustomMappings(XWikiDocument doc, XWikiContext context)
boolean	XWikiHibernateStore.injectCustomMappings(XWikiDocument doc, XWikiContext inputxcontext)
XWikiDocument	XWikiHibernateVersioningStore.loadXWikiDoc(XWikiDocument basedoc, String sversion, XWikiContext inputxcontext)
XWikiDocument	XWikiVersioningStoreInterface.loadXWikiDoc(XWikiDocument doc, String version, XWikiContext context)
XWikiDocument	XWikiStoreInterface.loadXWikiDoc(XWikiDocument doc, XWikiContext context)
XWikiDocument	XWikiCacheStore.loadXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
XWikiDocument	XWikiHibernateStore.loadXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext)
default void	XWikiStoreInterface.renameXWikiDoc(XWikiDocument doc, DocumentReference newReference, XWikiContext context) Atomic operation for renaming a document.
void	XWikiCacheStore.renameXWikiDoc(XWikiDocument doc, DocumentReference newReference, XWikiContext inputxcontext)
void	XWikiHibernateStore.renameXWikiDoc(XWikiDocument doc, DocumentReference newReference, XWikiContext inputxcontext) Atomic operation for renaming a document.
void	XWikiHibernateVersioningStore.resetRCSArchive(XWikiDocument doc, boolean bTransaction, XWikiContext inputxcontext)
void	XWikiVersioningStoreInterface.resetRCSArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)
XWikiDocument	XWikiHibernateRecycleBinStore.restoreFromRecycleBin(XWikiDocument doc, long index, XWikiContext inputxcontext, boolean bTransaction)
XWikiDocument	XWikiRecycleBinStoreInterface.restoreFromRecycleBin(XWikiDocument doc, long index, XWikiContext context, boolean bTransaction) Deprecated. since 9.4RC1. The document parameter is useless and gets in the way. Use XWikiRecycleBinStoreInterface.restoreFromRecycleBin(long, XWikiContext, boolean) instead.
void	XWikiRecycleBinContentStoreInterface.save(XWikiDocument doc, long index, boolean bTransaction) Save document to recycle bin.
void	XWikiHibernateAttachmentStore.saveAttachmentsContent(List<XWikiAttachment> attachments, XWikiDocument doc, boolean bParentUpdate, XWikiContext inputxcontext, boolean bTransaction)
void	XWikiAttachmentStoreInterface.saveAttachmentsContent(List<XWikiAttachment> attachments, XWikiDocument doc, boolean bParentUpdate, XWikiContext context, boolean bTransaction)
void	XWikiStoreInterface.saveLinks(XWikiDocument doc, XWikiContext context, boolean bTransaction)
void	XWikiCacheStore.saveLinks(XWikiDocument doc, XWikiContext context, boolean bTransaction)
void	XWikiHibernateStore.saveLinks(XWikiDocument doc, XWikiContext inputxcontext, boolean bTransaction)
void	XWikiHibernateRecycleBinStore.saveToRecycleBin(XWikiDocument doc, String deleter, Date date, String batchId, XWikiContext inputxcontext, boolean bTransaction)
default void	XWikiRecycleBinStoreInterface.saveToRecycleBin(XWikiDocument doc, String deleter, Date date, String batchId, XWikiContext context, boolean bTransaction) Save document to recycle bin.
void	XWikiHibernateRecycleBinStore.saveToRecycleBin(XWikiDocument doc, String deleter, Date date, XWikiContext inputxcontext, boolean bTransaction)
void	XWikiRecycleBinStoreInterface.saveToRecycleBin(XWikiDocument doc, String deleter, Date date, XWikiContext context, boolean bTransaction) Save document to recycle bin.
void	XWikiStoreInterface.saveXWikiDoc(XWikiDocument doc, XWikiContext context)
void	XWikiCacheStore.saveXWikiDoc(XWikiDocument doc, XWikiContext context)
void	XWikiHibernateStore.saveXWikiDoc(XWikiDocument doc, XWikiContext context)
void	XWikiStoreInterface.saveXWikiDoc(XWikiDocument doc, XWikiContext context, boolean bTransaction)
void	XWikiCacheStore.saveXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext, boolean bTransaction)
void	XWikiHibernateStore.saveXWikiDoc(XWikiDocument doc, XWikiContext inputxcontext, boolean bTransaction)
void	XWikiHibernateVersioningStore.updateXWikiDocArchive(XWikiDocument doc, boolean bTransaction, XWikiContext inputxcontext)
void	XWikiVersioningStoreInterface.updateXWikiDocArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context)

Method parameters in com.xpn.xwiki.store with type arguments of type XWikiDocument

Modifier and Type	Method and Description
void	XWikiCacheStore.setCache(org.xwiki.cache.Cache<XWikiDocument> cache)

Uses of XWikiDocument in com.xpn.xwiki.store.hibernate

Methods in com.xpn.xwiki.store.hibernate with parameters of type XWikiDocument

Modifier and Type	Method and Description
List<DeletedAttachment>	HibernateAttachmentRecycleBinStore.getAllDeletedAttachments(XWikiDocument doc, XWikiContext context, boolean bTransaction)

Uses of XWikiDocument in com.xpn.xwiki.user.api

Methods in com.xpn.xwiki.user.api with parameters of type XWikiDocument

Modifier and Type	Method and Description
boolean	XWikiRightService.checkAccess(String action, XWikiDocument doc, XWikiContext context) Checks if the wiki current user has the right to execute (@code action} on the document doc, along with redirecting to the login if it's not the case and there is no logged in user (the user is the guest user).
boolean	XWikiRightService.hasProgrammingRights(XWikiDocument doc, XWikiContext context) Deprecated. since 6.1RC1, use ContextualAuthorizationManager.hasAccess(org.xwiki.security.authorization.Right, org.xwiki.model.reference.EntityReference) instead

Uses of XWikiDocument in com.xpn.xwiki.user.impl.xwiki

Methods in com.xpn.xwiki.user.impl.xwiki with parameters of type XWikiDocument

Modifier and Type	Method and Description
boolean	XWikiRightServiceImpl.checkAccess(String action, XWikiDocument doc, XWikiContext context) Deprecated.
boolean	XWikiRightServiceImpl.checkRight(String userOrGroupName, XWikiDocument doc, String accessLevel, boolean user, boolean allow, boolean global, XWikiContext context) Deprecated.
boolean	XWikiRightServiceImpl.hasProgrammingRights(XWikiDocument doc, XWikiContext context) Deprecated.

Uses of XWikiDocument in com.xpn.xwiki.validation

Methods in com.xpn.xwiki.validation with parameters of type XWikiDocument

Modifier and Type	Method and Description
boolean	XWikiDefaultValidation.validateDocument(XWikiDocument doc, XWikiContext context)
boolean	XWikiValidationInterface.validateDocument(XWikiDocument doc, XWikiContext context)

Uses of XWikiDocument in com.xpn.xwiki.web

Methods in com.xpn.xwiki.web that return XWikiDocument

Modifier and Type	Method and Description
XWikiDocument	XWikiMessageTool.getDocumentBundle(String documentName) Deprecated. Helper method to help get a translated version of a document.
protected XWikiDocument	XWikiAction.getTranslatedDocument(XWikiDocument doc, String language, XWikiContext context) Gets the translated version of a document, in the specified language.
XWikiDocument	EditBean.getXWikiDoc()
protected XWikiDocument	EditAction.prepareEditedDocument(XWikiContext context) Determines the edited document (translation) and updates it based on the template specified on the request and any additional request parameters that overwrite the default values from the template.

Methods in com.xpn.xwiki.web that return types with arguments of type XWikiDocument

Modifier and Type	Method and Description
List<XWikiDocument>	XWikiMessageTool.getDocumentBundles() Deprecated.
List<XWikiDocument>	XWikiMessageTool.getDocumentBundles(String documentName, String defaultLanguage) Deprecated. Helper method to help get a translated version of a document.

Methods in com.xpn.xwiki.web with parameters of type XWikiDocument

Modifier and Type	Method and Description
XWikiAttachment	XWikiServletURLFactory.findAttachmentForDocRevision(XWikiDocument doc, String docRevision, String filename, XWikiContext context)
long	XWikiServletURLFactory.findDeletedAttachmentForDocRevision(XWikiDocument doc, String docRevision, String filename, XWikiContext context)
Properties	XWikiMessageTool.getDocumentBundleProperties(XWikiDocument docBundle) Deprecated.
protected BaseObject	ObjectRemoveAction.getObject(XWikiDocument doc, XWikiContext context)
protected XWikiDocument	XWikiAction.getTranslatedDocument(XWikiDocument doc, String language, XWikiContext context) Gets the translated version of a document, in the specified language.
boolean	CreateActionRequestHandler.isDocumentAlreadyExisting(XWikiDocument newDocument)
protected boolean	XWikiAction.readFromTemplate(XWikiDocument document, String template, XWikiContext context) Helper used by various actions to initialize a document by copying a template to it.
boolean	SkinAction.renderFileFromAttachment(String filename, XWikiDocument doc, XWikiContext context) Tries to serve the content of an attachment as a skin file.
boolean	SkinAction.renderFileFromObjectField(String filename, XWikiDocument doc, XWikiContext context) Tries to serve the content of an XWikiSkins object field as a skin file.
void	EditBean.setXWikiDoc(XWikiDocument xWikiDoc)
boolean	UploadAction.uploadAttachment(String fieldName, String filename, FileUploadPlugin fileupload, XWikiDocument doc, XWikiContext context) Attach a file to the current document.