Uses of Class
com.xpn.xwiki.api.Document

Packages that use Document
com.xpn.xwiki.api   
com.xpn.xwiki.doc   
com.xpn.xwiki.plugin.rightsmanager   
com.xpn.xwiki.script.display   
com.xpn.xwiki.script.sheet   
com.xpn.xwiki.xmlrpc   
 

Uses of Document in com.xpn.xwiki.api
 

Methods in com.xpn.xwiki.api that return Document
protected  Document Api.convert(XWikiDocument xdoc)
          Convert an internal representation of document to public api document.
 Document XWiki.createDocument()
          API to create an empty document
 Document Attachment.getDocument()
           
 Document DeletedDocument.getDocument()
           
 Document XWiki.getDocument(DocumentReference reference)
          Loads an Document from the database.
 Document XWiki.getDocument(Document doc, String rev)
          Load a specific revision of a document
 Document XWiki.getDocument(String fullName)
          Loads an Document from the database.
 Document XWiki.getDocument(String space, String fullname)
          Loads an Document from the database.
 Document XWiki.getDocumentAsAuthor(DocumentReference reference)
          Loads an Document from the database.
 Document XWiki.getDocumentAsAuthor(String fullName)
          Loads an Document from the database.
 Document Document.getDocumentRevision(String revision)
          Allow to easily access any revision of a document
 Document Document.getPreviousDocument()
          Allow to easily access the previous revision of a document
 Document Document.getTranslatedDocument()
           
 Document Document.getTranslatedDocument(String language)
           
 

Methods in com.xpn.xwiki.api that return types with arguments of type Document
protected  List<Document> Api.convert(List<XWikiDocument> xdocList)
          Convert a list of internal representation of documents to public api documents.
 List<Document> XWiki.searchDocuments(String wheresql, boolean distinctbylanguage)
          API allowing to search for documents allowing to have mutliple entries per language
 List<Document> XWiki.searchDocuments(String wheresql, boolean distinctbylanguage, int nb, int start)
          API allowing to search for documents allowing to have multiple entries per language
 List<Document> XWiki.wrapDocs(List<?> docs)
          Function to wrap a list of XWikiDocument into Document objects
 

Methods in com.xpn.xwiki.api with parameters of type Document
 List<AttachmentDiff> Document.getAttachmentDiff(Document origdoc, Document newdoc)
           
 List<List<ObjectDiff>> Document.getClassDiff(Document origdoc, Document newdoc)
           
 List<org.suigeneris.jrcs.diff.delta.Delta> Document.getContentDiff(Document origdoc, Document newdoc)
           
 Document XWiki.getDocument(Document doc, String rev)
          Load a specific revision of a document
 List<MetaDataDiff> Document.getMetaDataDiff(Document origdoc, Document newdoc)
           
 List<List<ObjectDiff>> Document.getObjectDiff(Document origdoc, Document newdoc)
           
 List<org.suigeneris.jrcs.diff.delta.Delta> Document.getRenderedContentDiff(Document origdoc, Document newdoc)
           
 List<org.suigeneris.jrcs.diff.delta.Delta> Document.getXMLDiff(Document origdoc, Document newdoc)
           
 boolean XWiki.renamePage(Document doc, String newFullName)
          API to rename a page (experimental) Rights are necessary to edit the source and target page All objects and attachments ID are modified in the process to link to the new page name
 String XWiki.renderChunk(org.suigeneris.jrcs.diff.delta.Chunk chunk, boolean source, Document doc)
          API to render a chunk (difference between two versions
 String XWiki.renderChunk(org.suigeneris.jrcs.diff.delta.Chunk chunk, Document doc)
          API to render a chunk (difference between two versions
 String XWiki.renderText(String text, Document doc)
          API to render a text in the context of a document
 

Constructors in com.xpn.xwiki.api with parameters of type Document
Attachment(Document doc, XWikiAttachment attachment, XWikiContext context)
           
 

Uses of Document in com.xpn.xwiki.doc
 

Methods in com.xpn.xwiki.doc that return Document
 Document XWikiDocument.newDocument(Class<?> customClass, XWikiContext context)
          Create a new protected Document public API to access page information and actions from scripting.
 Document XWikiDocument.newDocument(String customClassName, XWikiContext context)
          Create a new protected Document public API to access page information and actions from scripting.
 Document XWikiDocument.newDocument(XWikiContext context)
           
 

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

Methods in com.xpn.xwiki.plugin.rightsmanager that return Document
 Document RightsManagerRightsApi.getParentPreference(String spaceOrPage)
          Get the document containing inherited rights of provided document.
 

Methods in com.xpn.xwiki.plugin.rightsmanager that return types with arguments of type Document
 List<Document> RightsManagerGroupsApi.getAllGlobalGroups()
          Get all groups in the main wiki.
 List<Document> RightsManagerGroupsApi.getAllGlobalGroups(int nb, int start)
          Get all groups in the main wiki.
 List<Document> RightsManagerUsersApi.getAllGlobalUsers()
          Get all users in the main wiki.
 List<Document> RightsManagerUsersApi.getAllGlobalUsers(int nb, int start)
          Get all users in the main wiki.
 List<Document> RightsManagerGroupsApi.getAllGroups()
          Get all groups in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllGroups(int nb, int start)
          Get all groups in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllLocalGroups()
          Get all groups in the current wiki.
 List<Document> RightsManagerGroupsApi.getAllLocalGroups(int nb, int start)
          Get all groups in the current wiki.
 List<Document> RightsManagerUsersApi.getAllLocalUsers()
          Get all users in the current wiki.
 List<Document> RightsManagerUsersApi.getAllLocalUsers(int nb, int start)
          Get all users in the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGlobalGroups(Map<?,?> matchFields)
          Get all groups in the main wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGlobalGroups(Map<?,?> matchFields, int nb, int start)
          Get all groups in the main wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGlobalGroups(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all groups in the main wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedGlobalUsers(Map<?,?> matchFields)
          Get all users in the main wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedGlobalUsers(Map<?,?> matchFields, int nb, int start)
          Get all users in the main wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedGlobalUsers(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all users in the main wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGroups(Map<?,?> matchFields)
          Get all groups in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGroups(Map<?,?> matchFields, int nb, int start)
          Get all groups in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedGroups(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all groups in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedLocalGroups(Map<?,?> matchFields)
          Get all groups in the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedLocalGroups(Map<?,?> matchFields, int nb, int start)
          Get all groups in the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedLocalGroups(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all groups in the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedLocalUsers(Map<?,?> matchFields)
          Get all users in the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedLocalUsers(Map<?,?> matchFields, int nb, int start)
          Get all users in the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedLocalUsers(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all users in the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedUsers(Map<?,?> matchFields)
          Get all users in the main wiki and the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedUsers(Map<?,?> matchFields, int nb, int start)
          Get all users in the main wiki and the current wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedUsers(Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all users in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields)
          Get all groups in the provided wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields, int nb, int start)
          Get all groups in the provided wiki.
 List<Document> RightsManagerGroupsApi.getAllMatchedWikiGroups(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all groups in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields)
          Get all users in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields, int nb, int start)
          Get all users in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order)
          Get all users in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllUsers()
          Get all users in the main wiki and the current wiki.
 List<Document> RightsManagerUsersApi.getAllUsers(int nb, int start)
          Get all users in the main wiki and the current wiki.
 List<Document> RightsManagerGroupsApi.getAllWikiGroups(String wikiName)
          Get all groups in the provided wiki.
 List<Document> RightsManagerGroupsApi.getAllWikiGroups(String wikiName, int nb, int start)
          Get all groups in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllWikiUsers(String wikiName)
          Get all users in the provided wiki.
 List<Document> RightsManagerUsersApi.getAllWikiUsers(String wikiName, int nb, int start)
          Get all users in the provided wiki.
 

Uses of Document in com.xpn.xwiki.script.display
 

Methods in com.xpn.xwiki.script.display with parameters of type Document
 String DisplayScriptService.content(Document document)
           
 String DisplayScriptService.content(Document document, Map<String,Object> parameters)
          Displays the content of the given document.
 String DisplayScriptService.title(Document document)
           
 String DisplayScriptService.title(Document document, Map<String,Object> parameters)
          Displays the document title.
 

Uses of Document in com.xpn.xwiki.script.sheet
 

Methods in com.xpn.xwiki.script.sheet with parameters of type Document
 boolean SheetScriptService.bindClassSheet(Document classDocument, DocumentReference sheetReference)
          Binds a sheet to a XWiki class.
 boolean SheetScriptService.bindDocumentSheet(Document document, DocumentReference sheetReference)
          Binds a sheet to a XWiki document.
 List<DocumentReference> SheetScriptService.getClassSheets(Document classDocument)
          Retrieves the list of sheets explicitly bound to a XWiki class.
 List<DocumentReference> SheetScriptService.getDocumentSheets(Document document)
          Retrieves the list of sheets explicitly bound to a XWiki document.
 List<DocumentReference> SheetScriptService.getSheets(Document document, String action)
          Returns the list of sheets associated with a XWiki document.
 boolean SheetScriptService.unbindClassSheet(Document classDocument, DocumentReference sheetReference)
          Removes the binding between a XWiki class and a sheet.
 boolean SheetScriptService.unbindDocumentSheet(Document document, DocumentReference sheetReference)
          Removes the binding between a XWiki document and a sheet.
 

Uses of Document in com.xpn.xwiki.xmlrpc
 

Methods in com.xpn.xwiki.xmlrpc that return Document
static Document XWikiUtils.getDocument(XWiki xwikiApi, String extendedPageId, boolean failIfDoesntExist)
           Gets a document.
 

Methods in com.xpn.xwiki.xmlrpc with parameters of type Document
static org.codehaus.swizzle.confluence.Comment DomainObjectFactory.createComment(Document document, Object commentObject)
          Create a comment object containing all the information concerning a document comment.
static org.codehaus.swizzle.confluence.Space DomainObjectFactory.createSpace(Document spaceWebHome)
          Create a space from its WebHome document.
static org.codehaus.swizzle.confluence.SpaceSummary DomainObjectFactory.createSpaceSummary(Document spaceWebHome)
          Create a space summary starting from the space Web home.
static XWikiObject DomainObjectFactory.createXWikiObject(XWiki xwiki, XWikiContext xwikiContext, Document document, Object object)
          Create an XWikiObject containing all the information and attributed of a given xwiki object.
static XWikiObjectSummary DomainObjectFactory.createXWikiObjectSummary(Document document, Object object)
          Create a summary of a given xwiki object.
static XWikiPage DomainObjectFactory.createXWikiPage(Document document, boolean useExtendedPageId)
          Create a page description from an XWiki document.
static XWikiPageHistorySummary DomainObjectFactory.createXWikiPageHistorySummary(Document document)
          Create a page history summary containing revision information about a document.
static XWikiPageSummary DomainObjectFactory.createXWikiPageSummary(Document document)
          Create a page summary description from an XWiki document.
static Object XWikiUtils.getObjectByGuid(Document doc, String guid)
           
 



Copyright © 2004–2014 XWiki. All rights reserved.