public class Document extends Api
XWikiDocument
In scripting, an object representing the document in which the script resides will be bound to a variable called
doc.Modifier and Type | Field and Description |
---|---|
protected boolean |
cloned
Indicates if this API wraps a cloned XWikiDocument.
|
protected Object |
currentObj
Convenience object used by object related methods.
|
protected XWikiDocument |
doc
The XWikiDocument object wrapped by this API.
|
Constructor and Description |
---|
Document(XWikiDocument doc,
XWikiContext context)
Document constructor.
|
Modifier and Type | Method and Description |
---|---|
Attachment |
addAttachment(String fileName,
byte[] data) |
Attachment |
addAttachment(String fileName,
InputStream iStream) |
int |
addAttachments() |
int |
addAttachments(String fieldName) |
Object |
addObjectFromRequest() |
Object |
addObjectFromRequest(String className) |
Object |
addObjectFromRequest(String className,
String prefix) |
List<Object> |
addObjectsFromRequest(String className) |
List<Object> |
addObjectsFromRequest(String className,
String prefix) |
boolean |
checkAccess(String right) |
boolean |
convertSyntax(String targetSyntaxId)
Convert the current document content from its current syntax to the new syntax passed as parameter.
|
int |
createNewObject(String classname)
Creates a New XWiki Object of the given classname
|
void |
delete() |
void |
deleteAsAuthor()
Delete the document if the
content author of the script calling this method has
permission to do so. |
protected void |
deleteDocument()
Remove document from the wiki.
|
void |
deleteWithProgrammingRights() |
String |
display(String fieldname)
Displays the given field.
|
String |
display(String fieldname,
Object obj)
Displays the given field of the given object
The display mode will be decided depending on page context
(edit or inline context will display in edit, view context in view)
This function can return html inside and html macro
|
String |
display(String fieldname,
String mode)
Displays the given field in the given mode.
|
String |
display(String fieldname,
String mode,
Object obj)
Displays the given field of the given object in the given mode.
|
String |
display(String fieldname,
String type,
Object obj,
String wrappingSyntaxId)
Displays the given field of the given object using the given mode and syntax rendering
The display mode will be decided depending on page context
(edit or inline context will display in edit, view context in view)
This function can return html inside and html macro
|
String |
display(String fieldname,
String mode,
String prefix)
Displays the given field in the given mode.
|
String |
display(String fieldname,
String mode,
String prefix,
Object obj)
Displays the given field of the given object in the given mode.
|
String |
displayEdit(PropertyClass pclass,
String prefix,
Collection object) |
String |
displayForm(String className) |
String |
displayForm(String className,
String header,
String format) |
String |
displayForm(String className,
String header,
String format,
boolean linebreak) |
String |
displayHidden(PropertyClass pclass,
String prefix,
Collection object) |
String |
displayPrettyName(String fieldname)
Displays the pretty name of the given field.
|
String |
displayPrettyName(String fieldname,
boolean showMandatory)
Displays the pretty name of the given field.
|
String |
displayPrettyName(String fieldname,
boolean showMandatory,
boolean before)
Displays the pretty name of the given field.
|
String |
displayPrettyName(String fieldname,
boolean showMandatory,
boolean before,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
displayPrettyName(String fieldname,
boolean showMandatory,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
displayPrettyName(String fieldname,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
displayRendered(PropertyClass pclass,
String prefix,
Collection object) |
String |
displayTooltip(String fieldname)
Displays the tooltip of the given field.
|
String |
displayTooltip(String fieldname,
Object obj)
Displays the tooltip of the given field of the given object.
|
String |
displayView(PropertyClass pclass,
String prefix,
Collection object) |
void |
dropPermissions()
Drop permissions for the remainder of the rendering cycle.
|
boolean |
equals(Object arg0) |
Object |
get(String classOrFieldName) |
String |
getActiveClass() |
String |
getArchive() |
Attachment |
getAttachment(String filename) |
List<AttachmentDiff> |
getAttachmentDiff(Document origdoc,
Document newdoc) |
List<Attachment> |
getAttachmentList() |
String |
getAttachmentRevisionURL(String filename,
String version)
Get an old revision of an attachment.
|
String |
getAttachmentRevisionURL(String filename,
String version,
String queryString)
Get an old revision of an attachment.
|
String |
getAttachmentURL(String filename)
Return the relative URL of download for the the given attachment name.
|
String |
getAttachmentURL(String filename,
String action)
Get the relative URL of the given action for the the given attachment name.
|
String |
getAttachmentURL(String filename,
String action,
String queryString)
Get the relative URL of an action on an attachment.
|
String |
getAuthor()
Get fullName of the profile document of the author of the current version of the document.
|
List<String> |
getBacklinks() |
List<String> |
getChildren()
Get document children.
|
List<String> |
getChildren(int nb,
int start)
Get document children.
|
List<List<ObjectDiff>> |
getClassDiff(Document origdoc,
Document newdoc) |
String |
getComment() |
Vector<Object> |
getComments() |
Vector<Object> |
getComments(boolean asc) |
String |
getContent()
Get raw content of the document, i.e.
|
String |
getContentAuthor()
Get fullName of the profile document of the author of the content modification of this document version.
|
List<org.suigeneris.jrcs.diff.delta.Delta> |
getContentDiff(Document origdoc,
Document newdoc) |
Date |
getContentUpdateDate()
Get the date when the content modification has been done on this document version.
|
Date |
getCreationDate() |
String |
getCreator()
Get fullName of the profile document of the document creator.
|
DocumentStats |
getCurrentMonthPageStats(String action)
Get statistics about the number of request for the current page during the current month.
|
List<RefererStats> |
getCurrentMonthRefStats()
Get referer statistics for the current document during the current month.
|
DocumentStats |
getCurrentMonthSpaceStats(String action)
Get statistics about the number of request for the current space during the current month.
|
Date |
getDate() |
String |
getDefaultEditMode() |
String |
getDefaultEditURL() |
String |
getDefaultLanguage() |
String |
getDefaultTemplate()
TODO document this or mark it deprecated
|
String |
getDisplayTitle()
Get document title.
|
protected XWikiDocument |
getDoc()
Get a clone of the XWikiDocument wrapped by this API.
|
XWikiDocument |
getDocument()
Get the XWikiDocument wrapped by this API.
|
XWikiDocumentArchive |
getDocumentArchive()
Get the archive of this document's history.
|
DocumentReference |
getDocumentReference()
returns the DocumentReference for the current document
|
Document |
getDocumentRevision(String revision)
Allow to easily access any revision of a document
|
String |
getEditURL(String action,
String mode) |
String |
getEditURL(String action,
String mode,
String language) |
String |
getEscapedContent()
Get the document's content XML-escaped.
|
String |
getExternalURL()
Get the external URL to do a given action on this document.
|
String |
getExternalURL(String action)
Get the external URL to do a given action on this document.
|
String |
getExternalURL(String action,
String queryString)
Get the URL to do a given action on this document.
|
Object |
getFirstObject(String fieldname)
Get the first object that contains the given fieldname
|
String |
getFormat()
TODO document this or mark it deprecated
|
String |
getFullName()
Get the fullName of the document.
|
long |
getId()
return the ID of the document.
|
List<String> |
getIncludedMacros() |
List<String> |
getIncludedPages() |
String |
getLanguage()
Deprecated.
since 5.4M1 use
getLocale() instead |
List<org.suigeneris.jrcs.diff.delta.Delta> |
getLastChanges() |
List<String> |
getLinkedPages() |
List<XWikiLink> |
getLinks() |
Locale |
getLocale()
Get the locale of the document.
|
boolean |
getLocked() |
Date |
getLockingDate() |
String |
getLockingUser() |
List<MetaDataDiff> |
getMetaDataDiff(Document origdoc,
Document newdoc) |
String |
getName()
return the name of a document.
|
Object |
getObject(String classname)
Get the first object matching the given classname
|
Object |
getObject(String classname,
boolean create)
get the object of the given className.
|
Object |
getObject(String classname,
int nb)
Get the object matching the given classname and given object number
|
Object |
getObject(String classname,
String key,
String value)
Get the first object of a given classname that has a field name matching the given value
When none found this method will return null
|
Object |
getObject(String classname,
String key,
String value,
boolean failover)
Get the first object of a given classname that has a field name matching the given value
|
List<List<ObjectDiff>> |
getObjectDiff(Document origdoc,
Document newdoc) |
int |
getObjectNumbers(String classname) |
Vector<Object> |
getObjects(String className)
Get the list of objects for a given classname classname
|
Vector<Object> |
getObjects(String classname,
String key,
String value)
Select a subset of objects from a given class, filtered on a "key = value" criteria.
|
String |
getParent()
Get the name of the parent of this document.
|
String |
getParentURL() |
String |
getPlainTitle()
Returns the document title as plain text
|
String |
getPrefixedFullName()
Get the complete fullName of the document.
|
Document |
getPreviousDocument()
Allow to easily access the previous revision of a document
|
String |
getPreviousVersion()
Get a string representing the previous version of the document.
|
org.suigeneris.jrcs.rcs.Version |
getRCSVersion()
Get a Version object representing the current version of the document.
|
String |
getRealLanguage()
Gets the real language of the document.
|
String[] |
getRecentRevisions() |
String[] |
getRecentRevisions(int nb) |
String |
getRenderedContent() |
String |
getRenderedContent(String text)
Deprecated.
since 1.6M1 use
getRenderedContent(String, String) |
String |
getRenderedContent(String text,
String syntaxId) |
String |
getRenderedContent(String text,
String sourceSyntaxId,
String targetSyntaxId) |
String |
getRenderedContent(org.xwiki.rendering.syntax.Syntax targetSyntax) |
List<org.suigeneris.jrcs.diff.delta.Delta> |
getRenderedContentDiff(Document origdoc,
Document newdoc) |
String |
getRenderedContentRestricted(String text,
String syntaxId)
Render a text in a restricted mode, where script macros are completely disabled.
|
String |
getRenderedTitle(String syntaxId)
Returns the title of the document rendered through wiki syntax and velocity
|
RevisionInfo |
getRevisionInfo(String version)
Get information about a document version : author, date, etc.
|
org.suigeneris.jrcs.rcs.Version[] |
getRevisions() |
List<String> |
getRevisions(RevisionCriteria criteria)
Get document versions matching criterias like author, minimum creation date, etc.
|
List<DocumentSection> |
getSections()
Get the top sections contained in the document.
|
String |
getSpace()
return the name of the space of the document for example if the fullName of a document is "MySpace.Mydoc", the
name is MySpace.
|
org.xwiki.rendering.syntax.Syntax |
getSyntax() |
String |
getSyntaxId()
Deprecated.
since 2.3M1 use
getSyntax() instead |
List<String> |
getTagList() |
String |
getTags() |
List<String> |
getTagsPossibleValues() |
String |
getTemplate()
TODO document this or mark it deprecated
|
String |
getTextArea() |
String |
getTitle()
Get the value of the title field of the document.
|
Map<String,Map<String,Object>> |
getTOC(int init,
int max,
boolean numbered)
Returns data needed for a generation of Table of Content for this document.
|
String |
getTranslatedContent() |
String |
getTranslatedContent(String language) |
Document |
getTranslatedDocument() |
Document |
getTranslatedDocument(String language) |
List<String> |
getTranslationList() |
String |
getURL()
Get the URL of this document.
|
String |
getURL(String action)
Get the URL to do a given action on this document.
|
String |
getURL(String action,
String queryString)
Get the URL to do a given action on this document.
|
String |
getValidationScript()
Retrieves the validation script associated with this document, a Velocity script that is executed when validating
the document data.
|
Object |
getValue(String fieldName) |
Object |
getValue(String fieldName,
Object object) |
String |
getVersion()
Get a string representing the current version of the document.
|
String |
getVersionHashCode() |
String |
getWiki()
Get the name wiki where the document is stored.
|
String |
getXMLContent() |
List<org.suigeneris.jrcs.diff.delta.Delta> |
getXMLDiff(Document origdoc,
Document newdoc) |
protected Vector<Object> |
getXObjects(List<BaseObject> objects) |
Class |
getxWikiClass() |
Class[] |
getxWikiClasses() |
Map<String,Vector<Object>> |
getxWikiObjects()
Get the list of all objects available in this document organized in a Map by classname
|
boolean |
hasAccessLevel(String level) |
boolean |
hasAccessLevel(String level,
String user)
Check if the current user has an access level on a given document.
|
void |
insertText(String text,
String marker) |
boolean |
isAdvancedContent() |
boolean |
isCreator(String username) |
boolean |
isCurrentLocalUserPage() |
boolean |
isCurrentUserCreator() |
boolean |
isCurrentUserPage() |
boolean |
isFromCache() |
boolean |
isHidden()
Indicates whether the document is 'hidden' or not, meaning that it should not be returned in public search
results or appear in the User Interface in general.
|
boolean |
isMinorEdit() |
boolean |
isMostRecent() |
boolean |
isNew() |
boolean |
isProgrammaticContent() |
boolean |
isTranslation() |
Object |
newObject(String classname)
Creates a New XWiki Object of the given classname
|
boolean |
removeObject(Object object)
Remove an XObject from the document.
|
boolean |
removeObjects(String className)
Remove all the objects of a given type (XClass) from the document.
|
void |
rename(DocumentReference newReference)
Rename the current document and all the backlinks leading to it.
|
void |
rename(DocumentReference newReference,
List<DocumentReference> backlinkDocumentNames,
List<DocumentReference> childDocumentNames)
Same as
rename(String, List) but the list of documents having the current document as their parent is
passed in parameter. |
void |
rename(String newDocumentName)
Rename the current document and all the backlinks leading to it.
|
void |
rename(String newDocumentName,
List<String> backlinkDocumentNames)
Rename the current document and all the links pointing to it in the list of passed backlink documents.
|
void |
rename(String newDocumentName,
List<String> backlinkDocumentNames,
List<String> childDocumentNames)
Same as
rename(String, List) but the list of documents having the current document as their parent is
passed in parameter. |
void |
save() |
void |
save(String comment) |
void |
save(String comment,
boolean minorEdit) |
void |
saveAsAuthor()
Save the document if the
content author of the script calling this method has
permission to do so. |
void |
saveAsAuthor(String comment)
Save the document if the
content author of the script calling this method has
permission to do so. |
void |
saveAsAuthor(String comment,
boolean minorEdit)
Save the document if the
content author of the script calling this method has
permission to do so. |
protected void |
saveDocument(String comment,
boolean minorEdit) |
void |
saveWithProgrammingRights() |
void |
saveWithProgrammingRights(String comment) |
void |
saveWithProgrammingRights(String comment,
boolean minorEdit) |
void |
set(String fieldname,
Object value) |
void |
set(String fieldname,
Object value,
Object obj) |
void |
setComment(String comment) |
void |
setContent(String content) |
void |
setCustomClass(String customClass) |
void |
setDefaultTemplate(String dtemplate) |
void |
setHidden(boolean hidden)
Indicates whether the document should be 'hidden' or not, meaning that it should not be returned in public search
results or appear in the User Interface in general.
|
void |
setMinorEdit(boolean isMinor) |
void |
setParent(String parent) |
void |
setSyntax(org.xwiki.rendering.syntax.Syntax syntax) |
void |
setSyntaxId(String syntaxId) |
void |
setTitle(String title) |
void |
setValidationScript(String validationScript)
Sets a new validation script for this document, a Velocity script that is executed when validating the document
data.
|
String |
toString() |
String |
toXML() |
org.dom4j.Document |
toXMLDocument() |
Object |
updateObjectFromRequest(String className) |
Object |
updateObjectFromRequest(String className,
String prefix) |
List<Object> |
updateObjectsFromRequest(String className) |
List<Object> |
updateObjectsFromRequest(String className,
String prefix) |
void |
use(Object object)
Setting the current object to the given object.
|
void |
use(String className)
Setting the current object to the first object of the given class name.
|
void |
use(String className,
int nb)
Setting the current object to the object of the given class name and the given number.
|
boolean |
validate() |
boolean |
validate(String[] classNames) |
convert, convert, convert, convertAttachments, getXWikiContext, hasAdminRights, hasProgrammingRights, hasWikiAdminRights
protected XWikiDocument doc
protected boolean cloned
protected Object currentObj
public Document(XWikiDocument doc, XWikiContext context)
doc
- The XWikiDocument object to wrap.context
- The current request context.public XWikiDocument getDocument()
protected XWikiDocument getDoc()
public long getId()
public DocumentReference getDocumentReference()
public String getName()
public String getSpace()
public String getWiki()
public String getFullName()
public String getPrefixedFullName()
public org.suigeneris.jrcs.rcs.Version getRCSVersion()
public String getVersion()
public String getPreviousVersion()
public String getTitle()
public String getDisplayTitle()
public String getPlainTitle()
public String getRenderedTitle(String syntaxId) throws XWikiException
XWikiException
XWikiDocument.getRenderedTitle(Syntax, XWikiContext)
public String getFormat()
public String getAuthor()
public String getContentAuthor()
public Date getDate()
public Date getContentUpdateDate()
public Date getCreationDate()
public String getParent()
public String getCreator()
public String getContent()
public org.xwiki.rendering.syntax.Syntax getSyntax()
@Deprecated public String getSyntaxId()
getSyntax()
insteadpublic String getLanguage()
getLocale()
insteadpublic Locale getLocale()
public String getTemplate()
public String getRealLanguage() throws XWikiException
XWikiException
public String getDefaultLanguage()
public String getDefaultTemplate()
public String getComment()
public boolean isMinorEdit()
public List<String> getTranslationList() throws XWikiException
XWikiException
public String getTranslatedContent() throws XWikiException
XWikiException
public String getTranslatedContent(String language) throws XWikiException
XWikiException
public Document getTranslatedDocument(String language) throws XWikiException
XWikiException
public Document getTranslatedDocument() throws XWikiException
XWikiException
public String getRenderedContent() throws XWikiException
XWikiException
@Deprecated public String getRenderedContent(String text) throws XWikiException
getRenderedContent(String, String)
text
- the text to renderXWikiException
public String getRenderedContent(String text, String syntaxId) throws XWikiException
text
- the text to rendersyntaxId
- the id of the Syntax used by the passed text (for example: "xwiki/1.0")XWikiException
public String getRenderedContentRestricted(String text, String syntaxId) throws XWikiException
text
- the text to rendersyntaxId
- the id of the Syntax used by the passed text (for example: "xwiki/1.0")XWikiException
public String getRenderedContent(String text, String sourceSyntaxId, String targetSyntaxId) throws XWikiException
text
- the text to rendersourceSyntaxId
- the id of the Syntax used by the passed text (for example: "xwiki/1.0")targetSyntaxId
- the id of the syntax in which to render the document contentXWikiException
public String getRenderedContent(org.xwiki.rendering.syntax.Syntax targetSyntax) throws XWikiException
targetSyntax
- the syntax in which to render the document contentXWikiException
- error when rendering contentpublic String getEscapedContent() throws XWikiException
XWikiException
public String getArchive() throws XWikiException
XWikiException
public XWikiDocumentArchive getDocumentArchive() throws XWikiException
XWikiDocumentArchive
.XWikiException
public boolean isNew()
public String getAttachmentURL(String filename)
filename
- the name of the attachmentpublic String getAttachmentURL(String filename, String action)
filename
- the name of the attachment.action
- what to do to the file for example "delattachment", "download" or "downloadrev".public String getAttachmentURL(String filename, String action, String queryString)
filename
- the name of the attachment.action
- what to do to the file for example "delattachment", "download" or "downloadrev"queryString
- parameters added to the URL, the "rev" parameter is used to specify a revision if using
the "downloadrev" action. The query string must not begin with an ? character.public String getAttachmentRevisionURL(String filename, String version)
filename
- the name of the attachment.version
- a revision number such as "1.1" or "1.2".public String getAttachmentRevisionURL(String filename, String version, String queryString)
filename
- the name of the attachment.version
- a revision number such as "1.1" or "1.2".queryString
- additional query parameters to pass in the request.public String getURL()
for an absolute URL which can used outside of the site.
public String getURL(String action)
action
- what to do to the document for example "view", "edit" or "inline".for an absolute URL which can used outside of the site.
public String getURL(String action, String queryString)
action
- what to do to the document for example "view", "edit" or "inline".queryString
- parameters to pass in the request eg: "paramA=value1¶mB=value2"for an absolute URL which can used outside of the site.
public String getExternalURL()
for a reletive URL which can only be used inside of the site.
public String getExternalURL(String action)
action
- what to do to the document for example "view", "edit" or "inline".for a relative URL which can only be used inside of the site.
public String getExternalURL(String action, String queryString)
action
- what to do to the document for example "view", "edit" or "inline".queryString
- parameters to pass in the request eg: "paramA=value1¶mB=value2"for a relative URL which can only be used inside of the site.
public String getParentURL() throws XWikiException
XWikiException
public Class getxWikiClass()
public Class[] getxWikiClasses()
public int createNewObject(String classname) throws XWikiException
classname
- the classname usedXWikiException
public Object newObject(String classname) throws XWikiException
classname
- the classname usedXWikiException
public boolean isFromCache()
public int getObjectNumbers(String classname)
classname
- the classname usedpublic Map<String,Vector<Object>> getxWikiObjects()
protected Vector<Object> getXObjects(List<BaseObject> objects)
public Vector<Object> getObjects(String className)
public Object getFirstObject(String fieldname)
fieldname
- name of the field to find in the objectpublic Object getObject(String classname, String key, String value, boolean failover)
classname
- name of the class of the object to look forkey
- name of the field to find in the objectvalue
- value of the field to find in the objectfailover
- true if the first object will be given when none foundpublic Vector<Object> getObjects(String classname, String key, String value)
classname
- The type of objects to return.key
- The name of the property used for filtering.value
- The required value.objects
matching the criteria. If no objects are found, or if the key is an
empty String, then an empty vector is returned.public Object getObject(String classname, String key, String value)
classname
- name of the class of the object to look forkey
- name of the field to find in the objectvalue
- value of the field to find in the objectpublic Object getObject(String classname)
classname
- name of the class of the object to look forpublic Object getObject(String classname, boolean create)
classname
- name of the class of the object to look forcreate
- true of the object should be created when it does not existpublic Object getObject(String classname, int nb)
classname
- name of the class of the objectnb
- number of the objectpublic String getXMLContent() throws XWikiException
XWikiException
public String toXML() throws XWikiException
XWikiException
public org.dom4j.Document toXMLDocument() throws XWikiException
XWikiException
public org.suigeneris.jrcs.rcs.Version[] getRevisions() throws XWikiException
XWikiException
public String[] getRecentRevisions() throws XWikiException
XWikiException
public String[] getRecentRevisions(int nb) throws XWikiException
XWikiException
public List<String> getRevisions(RevisionCriteria criteria) throws XWikiException
criteria
- criteria used to match versionsXWikiException
public RevisionInfo getRevisionInfo(String version) throws XWikiException
version
- the version you want to get information aboutXWikiException
public List<Attachment> getAttachmentList()
public void use(Object object)
object
- Object to use as a reference for further display callspublic void use(String className)
className
- class used to find the first object to use as the reference for display callspublic void use(String className, int nb)
className
- class used to find the object to use as the reference for display callsnb
- number of the object to use as the reference for display callspublic String getActiveClass()
public String displayPrettyName(String fieldname)
fieldname
- fieldname to display the pretty name ofpublic String displayPrettyName(String fieldname, Object obj)
fieldname
- fieldname to display the pretty name ofobj
- Object to find the class to display the pretty name ofpublic String displayPrettyName(String fieldname, boolean showMandatory)
fieldname
- fieldname to display the pretty name ofshowMandatory
- true to display a mandatory signpublic String displayPrettyName(String fieldname, boolean showMandatory, Object obj)
fieldname
- fieldname to display the pretty name ofobj
- Object to find the class to display the pretty name ofshowMandatory
- true to display a mandatory signpublic String displayPrettyName(String fieldname, boolean showMandatory, boolean before)
fieldname
- fieldname to display the pretty name ofshowMandatory
- true to display a mandatory signbefore
- true if the mandatory sign should be before the fieldpublic String displayPrettyName(String fieldname, boolean showMandatory, boolean before, Object obj)
fieldname
- fieldname to display the pretty name ofobject
- Object to find the class to display the pretty name ofshowMandatory
- true to display a mandatory signbefore
- true if the mandatory sign should be before the fieldpublic String displayTooltip(String fieldname)
fieldname
- fieldname to display the tooltip ofpublic String displayTooltip(String fieldname, Object obj)
fieldname
- fieldname to display the tooltip ofobject
- Object to find the class to display the tooltip ofpublic String display(String fieldname)
fieldname
- fieldname to displaypublic String display(String fieldname, String mode)
fieldname
- fieldname to displaymode
- display mode to use (view, edit, hidden, search)public String display(String fieldname, String mode, String prefix)
fieldname
- fieldname to displaymode
- display mode to use (view, edit, hidden, search)prefix
- prefix to use for the form namespublic String display(String fieldname, Object obj)
fieldname
- fieldname to displayobject
- object from which to take the fieldpublic String display(String fieldname, String type, Object obj, String wrappingSyntaxId)
fieldname
- the name of the field to displaytype
- the type of the field to displayobj
- the object containing the field to displaywrappingSyntaxId
- the syntax of the content in which the result will be included. This to take care of some
escaping depending of the syntax.public String display(String fieldname, String mode, Object obj)
fieldname
- fieldname to displaymode
- display mode to use (view, edit, hidden, search)object
- the object containing the field to displaypublic String display(String fieldname, String mode, String prefix, Object obj)
fieldname
- fieldname to displaymode
- display mode to use (view, edit, hidden, search)prefix
- prefix to use for the form namesobject
- the object containing the field to displaypublic String displayForm(String className, String header, String format, boolean linebreak)
public String displayRendered(PropertyClass pclass, String prefix, Collection object) throws XWikiException
XWikiException
public String displayView(PropertyClass pclass, String prefix, Collection object)
public String displayEdit(PropertyClass pclass, String prefix, Collection object)
public String displayHidden(PropertyClass pclass, String prefix, Collection object)
public Attachment getAttachment(String filename)
public List<org.suigeneris.jrcs.diff.delta.Delta> getContentDiff(Document origdoc, Document newdoc) throws XWikiException, org.suigeneris.jrcs.diff.DifferentiationFailedException
XWikiException
org.suigeneris.jrcs.diff.DifferentiationFailedException
public List<org.suigeneris.jrcs.diff.delta.Delta> getXMLDiff(Document origdoc, Document newdoc) throws XWikiException, org.suigeneris.jrcs.diff.DifferentiationFailedException
XWikiException
org.suigeneris.jrcs.diff.DifferentiationFailedException
public List<org.suigeneris.jrcs.diff.delta.Delta> getRenderedContentDiff(Document origdoc, Document newdoc) throws XWikiException, org.suigeneris.jrcs.diff.DifferentiationFailedException
XWikiException
org.suigeneris.jrcs.diff.DifferentiationFailedException
public List<MetaDataDiff> getMetaDataDiff(Document origdoc, Document newdoc) throws XWikiException
XWikiException
public List<List<ObjectDiff>> getObjectDiff(Document origdoc, Document newdoc)
public List<List<ObjectDiff>> getClassDiff(Document origdoc, Document newdoc)
public List<AttachmentDiff> getAttachmentDiff(Document origdoc, Document newdoc)
public List<org.suigeneris.jrcs.diff.delta.Delta> getLastChanges() throws XWikiException, org.suigeneris.jrcs.diff.DifferentiationFailedException
XWikiException
org.suigeneris.jrcs.diff.DifferentiationFailedException
public DocumentStats getCurrentMonthPageStats(String action)
action
- the type of request for which to retrieve statistics: view, edit...public DocumentStats getCurrentMonthSpaceStats(String action)
action
- the type of request for which to retrieve statistics: view, edit...public List<RefererStats> getCurrentMonthRefStats()
public boolean checkAccess(String right)
public boolean hasAccessLevel(String level)
public boolean hasAccessLevel(String level, String user)
Api
hasAccessLevel
in class Api
level
- The name of the right to verify (eg "programming", "admin", "register", etc).user
- The document for which to verify the right.public boolean getLocked()
public String getLockingUser()
public Date getLockingDate()
public String getTextArea()
public Map<String,Map<String,Object>> getTOC(int init, int max, boolean numbered)
init
- an intial level where the TOC generation should start atmax
- maximum level TOC is generated fornumbered
- if should generate numbering for headingspublic String getTags()
public void insertText(String text, String marker) throws XWikiException
XWikiException
public List<String> getBacklinks() throws XWikiException
XWikiException
public List<XWikiLink> getLinks() throws XWikiException
XWikiException
public List<DocumentSection> getSections() throws XWikiException
The section are filtered by xwiki.section.depth property on the maximum depth of the sections to return. This method is usually used to get "editable" sections.
XWikiException
public List<String> getChildren() throws XWikiException
XWikiException
public List<String> getChildren(int nb, int start) throws XWikiException
nb
- The number of results to return.start
- The number of results to skip before we begin returning results.XWikiException
public String getDefaultEditMode() throws XWikiException
XWikiException
- if an error happens when computing the edit modepublic String getDefaultEditURL() throws XWikiException
XWikiException
public String getEditURL(String action, String mode) throws XWikiException
XWikiException
public boolean isCurrentUserCreator()
public boolean isCurrentUserPage()
public boolean isCurrentLocalUserPage()
public boolean isCreator(String username)
public void setTitle(String title)
public void setCustomClass(String customClass)
public void setParent(String parent)
public void setContent(String content)
public void setSyntax(org.xwiki.rendering.syntax.Syntax syntax)
syntax
- the Syntax representing the syntax used for the current document's content.public void setSyntaxId(String syntaxId)
syntaxId
- the Syntax id representing the syntax used for the current document. For example "xwiki/1.0"
represents the first version XWiki syntax while "xwiki/2.0" represents version 2.0 of the XWiki
Syntax.public void setDefaultTemplate(String dtemplate)
public void setComment(String comment)
public void setMinorEdit(boolean isMinor)
public void save() throws XWikiException
XWikiException
public void save(String comment) throws XWikiException
XWikiException
public void save(String comment, boolean minorEdit) throws XWikiException
XWikiException
public void saveWithProgrammingRights() throws XWikiException
XWikiException
public void saveWithProgrammingRights(String comment) throws XWikiException
XWikiException
public void saveWithProgrammingRights(String comment, boolean minorEdit) throws XWikiException
XWikiException
public void saveAsAuthor() throws XWikiException
content author
of the script calling this method has
permission to do so. The author of this document is also set to the said content author.XWikiException
- if script author is not allowed to save the document or if save operation fails.public void saveAsAuthor(String comment) throws XWikiException
content author
of the script calling this method has
permission to do so. The author of this document is also set to the said content author.comment
- The comment to display in document history (what did you change in the document)XWikiException
- if script author is not allowed to save the document or if save operation fails.public void saveAsAuthor(String comment, boolean minorEdit) throws XWikiException
content author
of the script calling this method has
permission to do so. The author of this document is also set to the said content author.comment
- The comment to display in document history (what did you change in the document)minorEdit
- Set true to advance the document version number by 0.1 or false to advance version to the next
integer + 0.1 eg: 25.1XWikiException
- if script author is not allowed to save the document or if save operation fails.protected void saveDocument(String comment, boolean minorEdit) throws XWikiException
XWikiException
public Object addObjectFromRequest() throws XWikiException
XWikiException
public Object addObjectFromRequest(String className) throws XWikiException
XWikiException
public List<Object> addObjectsFromRequest(String className) throws XWikiException
XWikiException
public Object addObjectFromRequest(String className, String prefix) throws XWikiException
XWikiException
public List<Object> addObjectsFromRequest(String className, String prefix) throws XWikiException
XWikiException
public Object updateObjectFromRequest(String className) throws XWikiException
XWikiException
public List<Object> updateObjectsFromRequest(String className) throws XWikiException
XWikiException
public Object updateObjectFromRequest(String className, String prefix) throws XWikiException
XWikiException
public List<Object> updateObjectsFromRequest(String className, String prefix) throws XWikiException
XWikiException
public boolean isAdvancedContent()
public boolean isProgrammaticContent()
public boolean removeObject(Object object)
object
- the object to removetrue
if the object was successfully removed, false
if the object was not found in the
current document.public boolean removeObjects(String className)
className
- The class name of the objects to be removed.true
if the objects were successfully removed, false
if no object from the target class
was in the current document.protected void deleteDocument() throws XWikiException
cloned
.XWikiException
public void delete() throws XWikiException
XWikiException
public void deleteAsAuthor() throws XWikiException
content author
of the script calling this method has
permission to do so. The deleter is also set to the said content author.XWikiException
- if script author is not allowed to delete the document or if save operation fails.public void deleteWithProgrammingRights() throws XWikiException
XWikiException
public String getVersionHashCode()
public int addAttachments() throws XWikiException
XWikiException
public int addAttachments(String fieldName) throws XWikiException
XWikiException
public Attachment addAttachment(String fileName, InputStream iStream)
public Attachment addAttachment(String fileName, byte[] data)
public boolean validate() throws XWikiException
XWikiException
public boolean validate(String[] classNames) throws XWikiException
XWikiException
public String getValidationScript()
String
representation of the validation script, or an empty string if there is no such
script.public void setValidationScript(String validationScript)
validationScript
- The new validation script, which can be an empty string or null
if the
script should be removed.public void rename(String newDocumentName) throws XWikiException
rename(String, java.util.List, java.util.List)
for more details.newDocumentName
- the new document name. If the space is not specified then defaults to the current space.XWikiException
- in case of an errorpublic void rename(DocumentReference newReference) throws XWikiException
rename(String, java.util.List, java.util.List)
for more details.newReference
- the reference to the new documentXWikiException
- in case of an errorpublic void rename(String newDocumentName, List<String> backlinkDocumentNames) throws XWikiException
Note: links without a space are renamed with the space added and all documents which have the document being renamed as parent have their parent field set to "currentwiki:CurrentSpace.Page".
newDocumentName
- the new document name. If the space is not specified then defaults to the current space.backlinkDocumentNames
- the list of documents to parse and for which links will be modified to point to the
new renamed document.XWikiException
- in case of an errorpublic void rename(String newDocumentName, List<String> backlinkDocumentNames, List<String> childDocumentNames) throws XWikiException
rename(String, List)
but the list of documents having the current document as their parent is
passed in parameter.newDocumentName
- the new document name. If the space is not specified then defaults to the current space.backlinkDocumentNames
- the list of documents to parse and for which links will be modified to point to the
new renamed document.childDocumentNames
- the list of documents whose parent field will be set to the new document name.XWikiException
- in case of an errorpublic void rename(DocumentReference newReference, List<DocumentReference> backlinkDocumentNames, List<DocumentReference> childDocumentNames) throws XWikiException
rename(String, List)
but the list of documents having the current document as their parent is
passed in parameter.newReference
- the reference to the new documentbacklinkDocumentNames
- the list of reference to documents to parse and for which links will be modified to
point to the new renamed documentchildDocumentNames
- the list of references to documents whose parent field will be set to the new document
referenceXWikiException
- in case of an errorpublic Document getDocumentRevision(String revision)
revision
- the version to accessnull
if the revision does not exist.public Document getPreviousDocument() throws XWikiException
XWikiException
public boolean isMostRecent()
public boolean convertSyntax(String targetSyntaxId) throws XWikiException
targetSyntaxId
- the syntax to convert to (eg "xwiki/2.0", "xhtml/1.0", etc)XWikiException
- if an exception occurred during the conversion processpublic boolean isHidden()
true
if the document is hidden, false
otherwise.public void setHidden(boolean hidden)
hidden
- true
if the document should be 'hidden', false
otherwise.public void dropPermissions()
Api.hasProgrammingRights()
will always return false.XWiki.getDocumentAsAuthor(org.xwiki.model.reference.DocumentReference)
,
XWiki.getDocumentAsAuthor(String)
, saveAsAuthor()
,
saveAsAuthor(String)
,
saveAsAuthor(String, boolean)
, and
deleteAsAuthor()
will perform all of their actions as if the document's
content author was the guest user (XWiki.XWikiGuest).
This sandboxing will expire at the end of the rendering cycle and can be suspended by
beginning a new rendering cycle. A rendering cycle can be begin by calling
getRenderedContent(String)
, display(String)
(or variations thereof)
or by invoking the include macro or using XWiki.includeTopic(String)
NOTE: Even if you include the same document, permissions will be regained. What this does is sandbox the remainder of the code on the page because although it can temporarily suspend the permissions drop, it cannot get itself to be executed with permissions because if it calls itself, it will hit the drop function first.
If you are interested in a more secure sandboxing method where code is guaranteed not
to have permissions for the remainder of the request, you should consider
Context.dropPermissions()
.
public boolean isTranslation()
getTranslatedDocument(String)
); false if this is actually the main document (i.e. returned by
XWiki.getDocument(DocumentReference)
.Copyright © 2004–2014 XWiki. All rights reserved.