public class LazyXWikiDocument extends XWikiDocument
The following informations are taken into account:
originalDocument remain the property of LazyXWikiDocument
object and is not taken from the lazy loaded
document since it depends on how this XWikiDocument
object is used (its technical meaning is its state in the
database before any modification but in the case of observation it's used as the previous version of the document).
TODO: we should probably think about a separation of theses two notions in something more clear, something for the
new model.
XWikiDocument.XWikiAttachmentToRemove
CKEY_SDOC, COMMENTSCLASS_REFERENCE, DB_SPACE_SEP, HAS_ATTACHMENTS, HAS_CLASS, HAS_OBJECTS, SHEETCLASS_REFERENCE, SPACE_NAME_SEP, version
Constructor and Description |
---|
LazyXWikiDocument()
Deprecated.
use
LazyXWikiDocument(DocumentReference) instead |
LazyXWikiDocument(DocumentReference documentReference) |
addAttachment, addAttachment, addAttachment, addObject, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectsFromRequest, addObjectsFromRequest, addObjectsToRemove, addToZip, addToZip, addToZip, addXObject, addXObject, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectsFromRequest, addXObjectsFromRequest, addXObjectsToRemoveFromVersion, addXObjectToRemove, appendMeta, apply, apply, backupContext, clearAttachmentsToRemove, clone, clone, cloneRename, cloneXObjects, containsXMLWikiDocument, convertSyntax, convertSyntax, copyAttachments, copyDocument, copyDocument, createNewObject, createXObject, display, display, display, display, display, display, display, display, display, display, display, displayDocument, displayDocument, displayDocument, displayDocument, displayEdit, displayForm, displayForm, displayForm, displayForm, displayForm, displayForm, displayHidden, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayRendered, displayTooltip, displayTooltip, displayView, duplicate, duplicateXObjects, encodedXMLStringAsUTF8, equals, equalsData, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, getAttachment, getAttachmentDiff, getAttachmentList, getAttachmentRevisionURL, getAttachmentRevisionURL, getAttachmentStore, getAttachmentsToRemove, getAttachmentURL, getAttachmentURL, getAttachmentURL, getAuthor, getBackLinkedPages, getBackLinkedReferences, getChildren, getChildren, getChildrenReferences, getChildrenReferences, getClassDiff, getComments, getComments, getContentAuthor, getContentDiff, getContentDiff, getContentDiff, getContentOfSection, getCreator, getDatabase, getDefaultEditMode, getDefaultEditURL, getDefaultLanguage, getDeltas, getDocumentReference, getDocumentReferenceWithLocale, getDocumentSection, getEditURL, getEditURL, getElement, getEscapedContent, getExactAttachment, getExternalAttachmentURL, getExternalURL, getExternalURL, getFirstObject, getFirstObject, getFullName, getIncludedMacros, getIncludedPages, getInternalProperty, getInternalPropertyName, getIntValue, getIntValue, getIntValue, getIntValue, getKey, getLanguage, getLastChanges, getListValue, getListValue, getListValue, getLocale, getLocalReferenceMaxLength, getLock, getLongValue, getLongValue, getLongValue, getMetaDataDiff, getMetaDataDiff, getMetaDataDiff, getMinorEdit1, getName, getNextVersion, getObject, getObject, getObject, getObject, getObject, getObjectDiff, getObjectDiff, getObjectDiff, getObjectNumbers, getObjects, getObjectsToRemove, getOriginalDocument, getPageName, getPageReference, getPageReferenceWithLocale, getParent, getParentDoc, getParentURL, getPrefixedFullName, getPreviousVersion, getRealLanguage, getRealLanguage, getRealLocale, getRecentRevisions, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContentDiff, getRenderedContentDiff, getRenderedContentDiff, getRenderedTitle, getRenderedTitle, getRevisionInfo, getRevisions, getRevisions, getSections, getSpace, getSpaceName, getStringValue, getStringValue, getStringValue, getStringValue, getSyntaxId, getTagsList, getTemplate, getTemplateDocumentReference, getTranslatedContent, getTranslatedContent, getTranslatedDocument, getTranslatedDocument, getTranslatedDocument, getTranslationList, getTranslationLocales, getUniqueLinkedPages, getUniqueWikiLinkedPages, getURL, getURL, getURL, getURL, getURL, getVersion, getVersionHashCode, getVersioningStore, getWeb, getWikiName, getXClasses, getXMLContent, getXMLDiff, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObjectProperty, getXObjects, getXObjects, getXObjectSize, getXObjectSize, getXObjectsToRemove, getxWikiClassXML, getxWikiObject, hasElement, hashCode, incrementVersion, insertText, is10Syntax, is10Syntax, isAdvancedContent, isContentDirty, isCreator, isCreator, isCurrentLocalUserPage, isCurrentUserCreator, isCurrentUserPage, isMetaDataDirty, isMinorEdit, isNew, isProgrammaticContent, loadAttachmentContent, loadAttachments, loadAttachmentsContent, loadAttachmentsContentSafe, loadDocumentArchive, merge, mergeXClass, mergeXObjects, mergexWikiClass, mergexWikiObjects, newDocument, newDocument, newDocument, newObject, newXObject, readDocMetaFromForm, readFromForm, readFromTemplate, readFromTemplate, readFromTemplate, readObjectsFromForm, readObjectsFromFormUpdateOrCreate, readTranslationMetaFromForm, removeAttachment, removeAttachment, removeLock, removeObject, removeObjects, removeXObject, removeXObjects, removeXObjects, rename, rename, rename, renameProperties, renameProperties, renderXDOM, resetArchive, resolveClassReference, restoreContext, saveAllAttachments, saveAllAttachments, saveAttachmentContent, saveAttachmentContent, saveAttachmentsContent, setAsContextDoc, setAttachment, setAttachment, setAttachmentList, setAuthor, setAuthorReference, setComment, setContent, setContent, setContentAuthor, setContentAuthorReference, setContentDirty, setContentUpdateDate, setCreationDate, setCreator, setCreatorReference, setCustomClass, setDatabase, setDate, setDBStringListValue, setDBStringListValue, setDefaultLanguage, setDefaultLocale, setDefaultTemplate, setDocumentArchive, setDocumentArchive, setDocumentReference, setElement, setElements, setFormat, setFromCache, setFullName, setFullName, setHidden, setId, setIntValue, setIntValue, setLanguage, setLargeStringValue, setLargeStringValue, setLocale, setLock, setMeta, setMetaDataDirty, setMinorEdit, setMinorEdit1, setMostRecent, setName, setNew, setObject, setOriginalDocument, setParent, setParentReference, setProperty, setProperty, setRCSVersion, setSpace, setStore, setStringListValue, setStringListValue, setStringValue, setStringValue, setSyntax, setSyntaxId, setTags, setTemplate, setTemplateDocumentReference, setTitle, setTranslation, setValidationScript, setVersion, setWeb, setWikiNode, setXClass, setXClassXML, setXObject, setXObject, setXObjects, setXObjects, setXObjectsToRemove, setxWikiClassXML, toFullXML, toString, toXML, toXML, toXML, toXML, toXML, toXML, toXMLDocument, updateDocumentSection, updateObjectFromRequest, updateObjectFromRequest, updateObjectFromRequest, updateObjectsFromRequest, updateObjectsFromRequest, updateXObjectFromRequest, updateXObjectFromRequest, updateXObjectFromRequest, updateXObjectsFromRequest, updateXObjectsFromRequest, validate, validate
@Deprecated public LazyXWikiDocument()
LazyXWikiDocument(DocumentReference)
insteadpublic LazyXWikiDocument(DocumentReference documentReference)
public org.suigeneris.jrcs.rcs.Version getRCSVersion()
getRCSVersion
in class XWikiDocument
public String getContent()
getContent
in interface DocumentModelBridge
getContent
in class XWikiDocument
public Map<DocumentReference,List<BaseObject>> getXObjects()
getXObjects
in class XWikiDocument
public BaseClass getXClass()
getXClass
in class XWikiDocument
public String getXClassXML()
getXClassXML
in class XWikiDocument
public DocumentReference getAuthorReference()
getAuthorReference
in class XWikiDocument
public DocumentReference getContentAuthorReference()
getContentAuthorReference
in interface DocumentModelBridge
getContentAuthorReference
in class XWikiDocument
public DocumentReference getCreatorReference()
getCreatorReference
in class XWikiDocument
public Date getDate()
getDate
in class XWikiDocument
public Date getCreationDate()
getCreationDate
in interface DocumentModelBridge
getCreationDate
in class XWikiDocument
public Date getContentUpdateDate()
getContentUpdateDate
in class XWikiDocument
public String getMeta()
getMeta
in class XWikiDocument
public String getTitle()
getTitle
in interface DocumentModelBridge
getTitle
in class XWikiDocument
public String getFormat()
getFormat
in class XWikiDocument
public Locale getDefaultLocale()
getDefaultLocale
in class XWikiDocument
public int getTranslation()
getTranslation
in class XWikiDocument
public String getCustomClass()
getCustomClass
in class XWikiDocument
public EntityReference getRelativeParentReference()
XWikiDocument
XWikiDocument.setParentReference(EntityReference)
.
You should use XWikiDocument.getParentReference()
reference if you want the complete parent reference.
getRelativeParentReference
in class XWikiDocument
public DocumentReference getParentReference()
getParentReference
in class XWikiDocument
public int getElements()
getElements
in class XWikiDocument
public String getDefaultTemplate()
getDefaultTemplate
in class XWikiDocument
public String getValidationScript()
getValidationScript
in class XWikiDocument
public String getComment()
getComment
in class XWikiDocument
public org.xwiki.rendering.syntax.Syntax getSyntax()
getSyntax
in interface DocumentModelBridge
getSyntax
in class XWikiDocument
public Boolean isHidden()
XWikiDocument
isHidden
in interface DocumentModelBridge
isHidden
in class XWikiDocument
true
if the document is hidden and does not appear among the results of
XWiki.searchDocuments(String)
, false
otherwise.public XWikiDocumentArchive getDocumentArchive()
getDocumentArchive
in class XWikiDocument
XWikiDocumentArchive
for this document. If it is not stored in the document, null is
returned.public void loadArchive(XWikiContext context) throws XWikiException
loadArchive
in class XWikiDocument
XWikiException
public XWikiDocumentArchive getDocumentArchive(XWikiContext context) throws XWikiException
getDocumentArchive
in class XWikiDocument
XWikiException
public XWikiStoreInterface getStore()
getStore
in class XWikiDocument
public long getId()
getId
in class XWikiDocument
public XWikiStoreInterface getStore(XWikiContext context)
getStore
in class XWikiDocument
public org.xwiki.rendering.block.XDOM getXDOM()
XWikiDocument
getXDOM
in interface DocumentModelBridge
getXDOM
in class XWikiDocument
public String getTags(XWikiContext context)
getTags
in class XWikiDocument
public List<String> getTagsPossibleValues(XWikiContext context)
getTagsPossibleValues
in class XWikiDocument
public boolean isFromCache()
isFromCache
in class XWikiDocument
public boolean isMostRecent()
isMostRecent
in class XWikiDocument
public org.dom4j.Document toXMLDocument(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, XWikiContext context) throws XWikiException
XWikiDocument
DOMDocument
. You should prefer
XWikiDocument.toXML(OutputStream, boolean, boolean, boolean, boolean, XWikiContext)
or
XWikiDocument.toXML(com.xpn.xwiki.internal.xml.XMLWriter, boolean, boolean, boolean, boolean, XWikiContext)
when
possible to reduce memory load.toXMLDocument
in class XWikiDocument
bWithObjects
- include XObjectsbWithRendering
- include the rendered contentbWithAttachmentContent
- include attachments contentbWithVersions
- include archived versionscontext
- current XWikiContextDOMDocument
containing the serialized document.XWikiException
- when an errors occurs during wiki operationspublic Object getWikiNode()
getWikiNode
in class XWikiDocument
Copyright © 2004–2022 XWiki. All rights reserved.