Uses of Class
com.xpn.xwiki.api.Document
-
Packages that use Document Package Description 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.web -
-
Uses of Document in com.xpn.xwiki.api
Methods in com.xpn.xwiki.api that return Document Modifier and Type Method Description protected Document
Api. convert(XWikiDocument xdoc)
Convert an internal representation of document to public api document.Document
XWiki. createDocument()
API to create an empty documentDocument
Attachment. getDocument()
Document
DeletedDocument. getDocument()
Document
XWiki. getDocument(Document doc, String rev)
Load a specific revision of a documentDocument
XWiki. getDocument(String documentReference)
Loads an Document from the database.Document
XWiki. getDocument(String space, String fullname)
Loads an Document from the database.Document
XWiki. getDocument(DocumentReference reference)
Loads a Document from the database.Document
XWiki. getDocument(DocumentReference reference, String revision)
Load a specific revision of a documentDocument
XWiki. getDocument(EntityReference reference)
Loads a Document from the store.Document
XWiki. getDocumentAsAuthor(String fullName)
Loads an Document from the database.Document
XWiki. getDocumentAsAuthor(DocumentReference reference)
Loads an Document from the database.Document
Document. getDocumentRevision(String revision)
Allow to easily access any revision of a documentDocument
XWiki. getEntityDocument(String reference, EntityType type)
Loads an Document from the database.Document
Document. getPreviousDocument()
Allow to easily access the previous revision of a documentDocument
Document. getTranslatedDocument()
Document
Document. getTranslatedDocument(String locale)
Methods in com.xpn.xwiki.api that return types with arguments of type Document Modifier and Type Method Description 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 distinctbylocale)
API allowing to search for documents allowing to have mutliple entries per localeList<Document>
XWiki. searchDocuments(String wheresql, boolean distinctbylocale, int nb, int start)
API allowing to search for documents allowing to have multiple entries per localeList<Document>
XWiki. wrapDocs(List<?> docs)
Function to wrap a list of XWikiDocument into Document objectsMethods in com.xpn.xwiki.api with parameters of type Document Modifier and Type Method Description 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 documentList<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)
Constructors in com.xpn.xwiki.api with parameters of type Document Constructor Description Attachment(Document doc, XWikiAttachment attachment, XWikiContext context)
-
Uses of Document in com.xpn.xwiki.doc
Methods in com.xpn.xwiki.doc that return Document Modifier and Type Method Description Document
XWikiDocument. newDocument(XWikiContext context)
Document
XWikiDocument. newDocument(Class<?> customClass, XWikiContext context)
Create a new protectedDocument
public API to access page information and actions from scripting.Document
XWikiDocument. newDocument(String customClassName, XWikiContext context)
Create a new protectedDocument
public API to access page information and actions from scripting. -
Uses of Document in com.xpn.xwiki.plugin.rightsmanager
Methods in com.xpn.xwiki.plugin.rightsmanager that return Document Modifier and Type Method Description 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 Modifier and Type Method Description 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 Modifier and Type Method Description 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 Modifier and Type Method Description 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.web
Methods in com.xpn.xwiki.web that return types with arguments of type Document Modifier and Type Method Description List<Document>
CreateActionRequestHandler. getAvailableTemplateProviders()
List<Document>
CreateActionRequestHandler. getRecommendedTemplateProviders()
-