A C D E F G H I L N O P R S T U V W X

A

add(int, int) - Method in class com.xpn.xwiki.api.Util
Add two integer numbers.
add(long, long) - Method in class com.xpn.xwiki.api.Util
Add two long numbers.
add(String, String) - Method in class com.xpn.xwiki.api.Util
Add two numbers, specified as strings.
addAttachment(String, InputStream) - Method in class com.xpn.xwiki.api.Document
 
addAttachment(String, byte[]) - Method in class com.xpn.xwiki.api.Document
 
addAttachments() - Method in class com.xpn.xwiki.api.Document
 
addAttachments(String) - Method in class com.xpn.xwiki.api.Document
 
addMandatory() - Method in class com.xpn.xwiki.api.XWiki
 
addObjectFromRequest() - Method in class com.xpn.xwiki.api.Document
 
addObjectFromRequest(String) - Method in class com.xpn.xwiki.api.Document
 
addObjectFromRequest(String, String) - Method in class com.xpn.xwiki.api.Document
 
addObjectsFromRequest(String) - Method in class com.xpn.xwiki.api.Document
 
addObjectsFromRequest(String, String) - Method in class com.xpn.xwiki.api.Document
 
addToAllGroup(String) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to add a user to the XWiki.XWikiAllGroup
addTooltip(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Inserts a tooltip using toolTip.js
addTooltip(String, String) - Method in class com.xpn.xwiki.api.XWiki
Inserts a tooltip using toolTip.js
addTooltipJS() - Method in class com.xpn.xwiki.api.XWiki
Inserts the tooltip Javascript
Api - Class in com.xpn.xwiki.api
Base class for all API Objects.
Api(XWikiContext) - Constructor for class com.xpn.xwiki.api.Api
 
Attachment - Class in com.xpn.xwiki.api
 
Attachment(Document, XWikiAttachment, XWikiContext) - Constructor for class com.xpn.xwiki.api.Attachment
 

C

canDelete() - Method in class com.xpn.xwiki.api.DeletedAttachment
Check if the current user has the right to permanently delete the attachment from the trash.
canDelete() - Method in class com.xpn.xwiki.api.DeletedDocument
 
canRestore() - Method in class com.xpn.xwiki.api.DeletedAttachment
Check if the current user has the right to restore the attachment.
canUndelete() - Method in class com.xpn.xwiki.api.DeletedDocument
Check if the current user has the right to restore the document.
checkAccess(String) - Method in class com.xpn.xwiki.api.Document
 
checkAccess(String, String) - Method in class com.xpn.xwiki.api.XWiki
Verify the rights the current user has on a document.
checkAuth() - Method in class com.xpn.xwiki.api.XWiki
Check authentication from request and set according persitent login information If it fails user is unlogged
checkAuth(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Check authentication from username and password and set according persitent login information If it fails user is unlogged
Class - Class in com.xpn.xwiki.api
 
Class(BaseClass, XWikiContext) - Constructor for class com.xpn.xwiki.api.Class
 
clearAccents(String) - Method in class com.xpn.xwiki.api.Util
Replace all accented characters by their ASCII equivalent.
clearName(String) - Method in class com.xpn.xwiki.api.Util
Cleans up the passed text by removing all accents and special characters to make it a valid page name.
cloned - Variable in class com.xpn.xwiki.api.Document
Indicates if this API wraps a cloned XWikiDocument.
Collection - Class in com.xpn.xwiki.api
 
Collection(BaseCollection, XWikiContext) - Constructor for class com.xpn.xwiki.api.Collection
 
com.xpn.xwiki.api - package com.xpn.xwiki.api
 
compareTo(PropertyClass) - Method in class com.xpn.xwiki.api.PropertyClass
Compares two property definitions based on their index number.
context - Variable in class com.xpn.xwiki.api.Api
The current context, needed by the underlying protected object.
Context - Class in com.xpn.xwiki.api
The Context class represents a secure proxy for the XWiki context, which in turn represents the execution environment for all the wiki pages.
Context(XWikiContext) - Constructor for class com.xpn.xwiki.api.Context
The Constructor.
convert(List<XWikiDocument>) - Method in class com.xpn.xwiki.api.Api
Convert a list of internal representation of documents to public api documents.
convert(XWikiDocument) - Method in class com.xpn.xwiki.api.Api
Convert an internal representation of document to public api document.
convertSyntax(String) - Method in class com.xpn.xwiki.api.Document
Convert the current document content from its current syntax to the new syntax passed as parameter.
convertToAlphaNumeric(String) - Method in class com.xpn.xwiki.api.Util
Removes all non alpha numerical characters from the passed text.
convertUsername(String) - Method in class com.xpn.xwiki.api.XWiki
API to convert the username depending on the configuration The username can be converted from email to a valid XWiki page name hidding the email address The username can be then used to login and link to the right user page
copyDocument(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to copy a document to another document in the same wiki
copyDocument(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to copy a translation of a document to another document in the same wiki
copyDocument(String, String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to copy a translation of a document to another document of the same name in another wiki
copyDocument(String, String, String, String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to copy a translation of a document to another document of the same name in another wiki additionally resetting the version
copyDocument(String, String, String, String, String, boolean, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to copy a translation of a document to another document of the same name in another wiki additionally resetting the version and overwriting the previous document
copyDocument(DocumentReference, DocumentReference, String, boolean, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to copy a translation of a document to another document of the same name in another wiki additionally resetting the version and overwriting the previous document
copySpaceBetweenWikis(String, String, String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
Privileged API to copy a space to another wiki, optionally deleting all document of the target space
countDocuments(String) - Method in class com.xpn.xwiki.api.XWiki
API allowing to count the total number of documents that would be returned by a query.
countDocuments(String, List<?>) - Method in class com.xpn.xwiki.api.XWiki
API allowing to count the total number of documents that would be returned by a parameterized query.
createDocument() - Method in class com.xpn.xwiki.api.XWiki
API to create an empty document
createNewObject(String) - Method in class com.xpn.xwiki.api.Document
 
createNewWiki(String, String, String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new Wiki from an existing wiki This creates the database, copies to documents from a existing wiki Assigns the admin rights, creates the Wiki identification page in the main wiki
createNewWiki(String, String, String, String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new Wiki from an existing wiki This creates the database, copies to documents from a existing wiki Assigns the admin rights, creates the Wiki identification page in the main wiki
createNewWiki(String, String, String, String, String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new Wiki from an existing wiki This creates the database, copies to documents from a existing wiki Assigns the admin rights, creates the Wiki identification page in the main wiki Copy is limited to documents of a specified language.
createUser() - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new user from the request This API is used by RegisterNewUser wiki page
createUser(boolean) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new user from the request This API is used by RegisterNewUser wiki page This version sends a validation email to the user Configuration of validation email is in the XWiki Preferences
createUser(boolean, String) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to create a new user from the request This API is used by RegisterNewUser wiki page This version sends a validation email to the user Configuration of validation email is in the XWiki Preferences
CriteriaService - Class in com.xpn.xwiki.api
Criteria service api.
CriteriaService(XWikiContext) - Constructor for class com.xpn.xwiki.api.CriteriaService
 
currentObj - Variable in class com.xpn.xwiki.api.Document
Convenience object used by object related methods.

D

decodeURI(String) - Method in class com.xpn.xwiki.api.Util
Decodes a application/x-www-form-urlencoded string, the reverse of Util.encodeURI(String).
delete() - Method in class com.xpn.xwiki.api.DeletedAttachment
Permanently delete this attachment from the trash.
delete() - Method in class com.xpn.xwiki.api.Document
 
deleteAsAuthor() - Method in class com.xpn.xwiki.api.Document
Delete the document if the content author of the script calling this method has permission to do so.
DeletedAttachment - Class in com.xpn.xwiki.api
Information about a deleted attachment in the recycle bin.
DeletedAttachment(DeletedAttachment, XWikiContext) - Constructor for class com.xpn.xwiki.api.DeletedAttachment
Simple constructor, initializes a new API object with the current context and the specified protected deleted attachment object.
DeletedDocument - Class in com.xpn.xwiki.api
Information about a deleted document in the recycle bin.
DeletedDocument(XWikiDeletedDocument, XWikiContext) - Constructor for class com.xpn.xwiki.api.DeletedDocument
Simple constructor, initializes a new API object with the current context and the specified protected deleted document object.
deleteDocument() - Method in class com.xpn.xwiki.api.Document
Remove document from the wiki.
deleteWithProgrammingRights() - Method in class com.xpn.xwiki.api.Document
 
display(String) - Method in class com.xpn.xwiki.api.Document
 
display(String, String) - Method in class com.xpn.xwiki.api.Document
 
display(String, String, String) - Method in class com.xpn.xwiki.api.Document
 
display(String, Object) - Method in class com.xpn.xwiki.api.Document
 
display(String, String, Object, String) - Method in class com.xpn.xwiki.api.Document
 
display(String, String, Object) - Method in class com.xpn.xwiki.api.Document
 
display(String, String, String, Object) - Method in class com.xpn.xwiki.api.Document
 
display(String, String) - Method in class com.xpn.xwiki.api.Object
 
displayEdit(PropertyClass, String, Collection) - Method in class com.xpn.xwiki.api.Document
 
displayForm(String, String, String) - Method in class com.xpn.xwiki.api.Document
 
displayForm(String, String, String, boolean) - Method in class com.xpn.xwiki.api.Document
 
displayForm(String) - Method in class com.xpn.xwiki.api.Document
 
displayHidden(PropertyClass, String, Collection) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String, Object) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String, boolean) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String, boolean, Object) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String, boolean, boolean) - Method in class com.xpn.xwiki.api.Document
 
displayPrettyName(String, boolean, boolean, Object) - Method in class com.xpn.xwiki.api.Document
 
displayRendered(PropertyClass, String, Collection) - Method in class com.xpn.xwiki.api.Document
 
displayTooltip(String) - Method in class com.xpn.xwiki.api.Document
 
displayTooltip(String, Object) - Method in class com.xpn.xwiki.api.Document
 
displayView(PropertyClass, String, Collection) - Method in class com.xpn.xwiki.api.Document
 
doc - Variable in class com.xpn.xwiki.api.Document
The XWikiDocument object wrapped by this API.
Document - Class in com.xpn.xwiki.api
This class represents a document or page in the wiki.
Document(XWikiDocument, XWikiContext) - Constructor for class com.xpn.xwiki.api.Document
Document constructor.
DocumentSection - Class in com.xpn.xwiki.api
 
DocumentSection(int, int, String, String) - Constructor for class com.xpn.xwiki.api.DocumentSection
 
dropPermissions() - Method in class com.xpn.xwiki.api.Context
After this is called: 1.
dropPermissions() - Method in class com.xpn.xwiki.api.Document
Drop permissions for the remainder of the rendering cycle.

E

Element - Class in com.xpn.xwiki.api
Element is a superclass for any XWiki Class, Object, or Property which might be stored in the database.
Element(BaseElement, XWikiContext) - Constructor for class com.xpn.xwiki.api.Element
The Constructor.
element - Variable in class com.xpn.xwiki.api.Element
The internal element which this wraps.
encodeURI(String) - Method in class com.xpn.xwiki.api.Util
Translates a string into application/x-www-form-urlencoded format, so that it can be safely used in a query string as a parameter value.
equals(Object) - Method in class com.xpn.xwiki.api.Document
 
equals(Object) - Method in class com.xpn.xwiki.api.Object
 
escapeSQL(String) - Method in class com.xpn.xwiki.api.Util
Escape text so that it can be used in a HQL/SQL query, in a like clause or in a test for equality clause.
escapeText(String) - Method in class com.xpn.xwiki.api.Util
Protect Text from Wiki transformation.
escapeURL(String) - Method in class com.xpn.xwiki.api.Util
Protect URLs from Wiki transformation.
exists(String) - Method in class com.xpn.xwiki.api.XWiki
Returns whether a document exists or not
exists(DocumentReference) - Method in class com.xpn.xwiki.api.XWiki
Returns whether a document exists or not

F

flushCache() - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to flush the cache of the Wiki installation This flushed the cache of all wikis, all plugins, all renderers
formatDate(Date) - Method in class com.xpn.xwiki.api.XWiki
API allowing to format a date according to the default Wiki setting The date format is provided in the 'dateformat' parameter of the XWiki Preferences
formatDate(Date, String) - Method in class com.xpn.xwiki.api.XWiki
API allowing to format a date according to a custom format The date format is from java.text.SimpleDateFormat Example: "dd/MM/yyyy HH:mm:ss" or "d MMM yyyy" If the format is invalid the default format will be used to show the date

G

generateRandomString(int) - Method in class com.xpn.xwiki.api.Util
Generate a random string, containing only alpha-numeric characters.
get(String) - Method in class com.xpn.xwiki.api.Class
 
get(String) - Method in class com.xpn.xwiki.api.Context
Returns the value associated with the given key in the XWiki context.
get(String) - Method in class com.xpn.xwiki.api.Document
 
get(String) - Method in class com.xpn.xwiki.api.Object
This method's name is misleading since it doesn't return the Object's property value; it"s equivalent to Object.display(String, String) (with type equals to view).
get(String) - Method in class com.xpn.xwiki.api.XWiki
Returns a plugin from the plugin API.
getAction() - Method in class com.xpn.xwiki.api.Context
Returns the current action.
getActionStatistics(String, Scope, Period, Duration) - Method in class com.xpn.xwiki.api.StatsService
Shows how the statistics for the specified action have evolved over the specified period of time.
getActiveClass() - Method in class com.xpn.xwiki.api.Document
 
getAdClientId() - Method in class com.xpn.xwiki.api.XWiki
Returns the Advertisement client ID from the preferences
getAdType() - Method in class com.xpn.xwiki.api.XWiki
Returns the Advertisement system from the preferences
getArchive() - Method in class com.xpn.xwiki.api.Document
 
getArrayList() - Method in class com.xpn.xwiki.api.Util
Creates an ArrayList.
getAttachment() - Method in class com.xpn.xwiki.api.Attachment
 
getAttachment() - Method in class com.xpn.xwiki.api.DeletedAttachment
Access to the real attachment object.
getAttachment(String) - Method in class com.xpn.xwiki.api.Document
 
getAttachmentDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getAttachmentList() - Method in class com.xpn.xwiki.api.Document
 
getAttachmentRevision(String) - Method in class com.xpn.xwiki.api.Attachment
Allow to easily access any revision of an attachment.
getAttachmentRevisionURL(String, String) - Method in class com.xpn.xwiki.api.Document
Get an old revision of an attachment.
getAttachmentRevisionURL(String, String, String) - Method in class com.xpn.xwiki.api.Document
Get an old revision of an attachment.
getAttachmentURL(String) - Method in class com.xpn.xwiki.api.Document
Return the URL of download for the the given attachment name.
getAttachmentURL(String, String) - Method in class com.xpn.xwiki.api.Document
Get the URL of the given action for the the given attachment name.
getAttachmentURL(String, String, String) - Method in class com.xpn.xwiki.api.Document
Get the URL of an action on an attachment.
getAttachmentURL(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of an attached file in a Wiki Document The URL is generated differently depending on the environement (Servlet, Portlet, PDF, etc..) The URL generation can be modified by implementing a new XWikiURLFactory object For compatibility with any target environement (and especially the portlet environment) It is important to always use the URL functions to generate URL and never hardcode URLs
getAuthor() - Method in class com.xpn.xwiki.api.Attachment
 
getAuthor() - Method in class com.xpn.xwiki.api.Document
Get fullName of the profile document of the author of the current version of the document.
getAuthor() - Method in class com.xpn.xwiki.api.RevisionInfo
 
getAvailableRendererSyntax(String, String) - Method in class com.xpn.xwiki.api.XWiki
Find the corresponding available renderer syntax.
getBacklinks() - Method in class com.xpn.xwiki.api.Document
 
getBackLinkStatistics(String, Scope, Period, Range) - Method in class com.xpn.xwiki.api.StatsService
Retrieves back-link statistics.
getBaseClass() - Method in class com.xpn.xwiki.api.Class
 
getBaseElement() - Method in class com.xpn.xwiki.api.Element
 
getBaseObject() - Method in class com.xpn.xwiki.api.Object
 
getBaseProperty() - Method in class com.xpn.xwiki.api.Property
 
getBasePropertyClass() - Method in class com.xpn.xwiki.api.PropertyClass
Internal access to the wrapped PropertyClass.
getBaseSkin() - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the current skin for this request and user.
getCacheDuration() - Method in class com.xpn.xwiki.api.Context
Returns the amount of time this document should be cached.
getChildren() - Method in class com.xpn.xwiki.api.Document
Get document children.
getChildren(int, int) - Method in class com.xpn.xwiki.api.Document
Get document children.
getClass(String) - Method in class com.xpn.xwiki.api.XWiki
Get the XWiki Class object defined in the passed Document name.
getClassDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getClassList() - Method in class com.xpn.xwiki.api.XWiki
Get the list of available classes in the wiki
getClassName() - Method in class com.xpn.xwiki.api.PropertyClass
Get the name of the XClass (Object Definition) this property definition belongs to.
getClassType() - Method in class com.xpn.xwiki.api.PropertyClass
Get the full name of the actual class of the wrapped PropertyClass.
getCollection() - Method in class com.xpn.xwiki.api.Collection
 
getComment() - Method in class com.xpn.xwiki.api.Attachment
 
getComment() - Method in class com.xpn.xwiki.api.Document
 
getComment() - Method in class com.xpn.xwiki.api.RevisionInfo
 
getComments() - Method in class com.xpn.xwiki.api.Document
 
getComments(boolean) - Method in class com.xpn.xwiki.api.Document
 
getConfiguredSyntaxes() - Method in class com.xpn.xwiki.api.XWiki
 
getContent() - Method in class com.xpn.xwiki.api.Attachment
 
getContent() - Method in class com.xpn.xwiki.api.Document
Get raw content of the document, i.e.
getContentAsBytes() - Method in class com.xpn.xwiki.api.Attachment
 
getContentAsString() - Method in class com.xpn.xwiki.api.Attachment
 
getContentAsString(String) - Method in class com.xpn.xwiki.api.Attachment
 
getContentAuthor() - Method in class com.xpn.xwiki.api.Document
Get fullName of the profile document of the author of the last content modification in the document.
getContentDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getContentUpdateDate() - Method in class com.xpn.xwiki.api.Document
Get the date when the last content modification has been done on the document.
getContext() - Method in class com.xpn.xwiki.api.Context
Returns the XWiki context.
getCounter(String) - Method in class com.xpn.xwiki.api.XWiki
Provides an absolute counter
getCreationDate() - Method in class com.xpn.xwiki.api.Document
Get the date when the document has been created.
getCreator() - Method in class com.xpn.xwiki.api.Document
Get fullName of the profile document of the document creator.
getCriteriaService() - Method in class com.xpn.xwiki.api.XWiki
API to get the xwiki criteria service which allow to create various criteria : integer ranges, date periods, date intervals, etc.
getCurrentContentSyntaxId() - Method in class com.xpn.xwiki.api.XWiki
Get the syntax of the document currently being executed.
getCurrentMonthPageStats(String) - Method in class com.xpn.xwiki.api.Document
Get statistics about the number of request for the current page during the current month.
getCurrentMonthRefStats() - Method in class com.xpn.xwiki.api.Document
Get referer statistics for the current document during the current month.
getCurrentMonthSpaceStats(String) - Method in class com.xpn.xwiki.api.Document
Get statistics about the number of request for the current space during the current month.
getCurrentMonthXWikiStats(String) - Method in class com.xpn.xwiki.api.XWiki
Deprecated. use XWiki.getStatsService() instead
getDatabase() - Method in class com.xpn.xwiki.api.Context
Returns the current database name.
getDate() - Method in class com.xpn.xwiki.api.Attachment
 
getDate() - Method in class com.xpn.xwiki.api.DeletedAttachment
Retrieve the date and time this attachment has been deleted.
getDate() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getDate() - Method in class com.xpn.xwiki.api.Document
Get the date when the current document version has been created, i.e.
getDate() - Method in class com.xpn.xwiki.api.RevisionInfo
 
getDate() - Method in class com.xpn.xwiki.api.Util
Creates a new Date object corresponding to the current time.
getDate(long) - Method in class com.xpn.xwiki.api.Util
Creates a new Date object corresponding to the specified time.
getDefaultDocumentSyntax() - Method in class com.xpn.xwiki.api.XWiki
 
getDefaultEditMode() - Method in class com.xpn.xwiki.api.Document
 
getDefaultEditURL() - Method in class com.xpn.xwiki.api.Document
 
getDefaultLanguage() - Method in class com.xpn.xwiki.api.Document
return the language of the default document
getDefaultTemplate() - Method in class com.xpn.xwiki.api.Document
 
getDeletedAttachment() - Method in class com.xpn.xwiki.api.DeletedAttachment
Privileged access to the internal object wrapped by this API.
getDeletedAttachment(String) - Method in class com.xpn.xwiki.api.XWiki
Retrieve a specific attachment from the trash.
getDeletedAttachments(String) - Method in class com.xpn.xwiki.api.XWiki
Retrieve all the deleted attachments that belonged to a certain document.
getDeletedAttachments(String, String) - Method in class com.xpn.xwiki.api.XWiki
Retrieve all the deleted attachments that belonged to a certain document and had the specified name.
getDeletedDocument() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getDeletedDocument(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
 
getDeletedDocuments(String, String) - Method in class com.xpn.xwiki.api.XWiki
 
getDeleter() - Method in class com.xpn.xwiki.api.DeletedAttachment
Retrieve the name of the user who deleted this attachment.
getDeleter() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getDeprecatedObjectProperties(Object) - Method in class com.xpn.xwiki.api.Class
Retrieves deprecated properties of the given object compared to the class.
getDeprecatedObjectPropertyNames(Object) - Method in class com.xpn.xwiki.api.Class
Get the names of deprecated properties of the given object compared to the class.
getDisabledObjectProperties(Object) - Method in class com.xpn.xwiki.api.Class
Get the list of disabled properties that exist in a given object.
getDisabledObjectPropertyNames(Object) - Method in class com.xpn.xwiki.api.Class
Get the names of the class properties that are disabled, and exist in the given object.
getDisabledProperties() - Method in class com.xpn.xwiki.api.Class
Get the list of disabled property definitions that exist in this class.
getDisabledPropertyNames() - Method in class com.xpn.xwiki.api.Class
Get the names of the class properties that are disabled.
getDisplayedFields() - Method in class com.xpn.xwiki.api.Context
Returns the list with the currently displayed fields.
getDisplayTitle() - Method in class com.xpn.xwiki.api.Document
Get document title.
getDoc() - Method in class com.xpn.xwiki.api.Context
Returns the current requested document.
getDoc() - Method in class com.xpn.xwiki.api.Document
Get a clone of the XWikiDocument wrapped by this API.
getDocId() - Method in class com.xpn.xwiki.api.Attachment
 
getDocName() - Method in class com.xpn.xwiki.api.DeletedAttachment
Retrieve the name of the document this attachment belonged to.
getDocument() - Method in class com.xpn.xwiki.api.Attachment
 
getDocument() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getDocument() - Method in class com.xpn.xwiki.api.Document
Get the XWikiDocument wrapped by this API.
getDocument(String) - Method in class com.xpn.xwiki.api.XWiki
Loads an Document from the database.
getDocument(DocumentReference) - Method in class com.xpn.xwiki.api.XWiki
Loads an Document from the database.
getDocument(String, String) - Method in class com.xpn.xwiki.api.XWiki
Loads an Document from the database.
getDocument(Document, String) - Method in class com.xpn.xwiki.api.XWiki
Load a specific revision of a document
getDocumentArchive() - Method in class com.xpn.xwiki.api.Document
Get the archive of this document's history.
getDocumentAsAuthor(String) - Method in class com.xpn.xwiki.api.XWiki
Loads an Document from the database.
getDocumentAsAuthor(DocumentReference) - Method in class com.xpn.xwiki.api.XWiki
Loads an Document from the database.
getDocumentReference() - Method in class com.xpn.xwiki.api.Document
 
getDocumentRevision(String) - Method in class com.xpn.xwiki.api.Document
Allow to easily access any revision of a document
getDocumentStatistics(String, Scope, Period, Range) - Method in class com.xpn.xwiki.api.StatsService
Retrieves document statistics.
getDurationFactory() - Method in class com.xpn.xwiki.api.CriteriaService
 
getEditorPreference() - Method in class com.xpn.xwiki.api.XWiki
Retrieves the current editor preference for the request The preference is first looked up in the user preference and then in the space and wiki preference
getEditorWysiwyg() - Method in class com.xpn.xwiki.api.Context
Returns the list of textarea fields that use the WYSIWYG editor.
getEditURL(String, String) - Method in class com.xpn.xwiki.api.Document
 
getEditURL(String, String, String) - Method in class com.xpn.xwiki.api.Document
 
getEmail() - Method in class com.xpn.xwiki.api.User
API to retrieve the e-mail address of this user.
getEnabledProperties() - Method in class com.xpn.xwiki.api.Class
Get the list of enabled (the default, normal state) property definitions that exist in this class.
getEnabledPropertyNames() - Method in class com.xpn.xwiki.api.Class
Get the names of the class properties that are enabled.
getEncoding() - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the current encoding of the wiki engine The encoding is stored in xwiki.cfg Default encoding is ISO-8891-1
getEscapedContent() - Method in class com.xpn.xwiki.api.Document
Get the document's content XML-escaped.
getExternalURL() - Method in class com.xpn.xwiki.api.Document
Get the external URL to do a given action on this document.
getExternalURL(String) - Method in class com.xpn.xwiki.api.Document
Get the external URL to do a given action on this document.
getExternalURL(String, String) - Method in class com.xpn.xwiki.api.Document
Get the URL to do a given action on this document.
getFilename() - Method in class com.xpn.xwiki.api.Attachment
 
getFilename() - Method in class com.xpn.xwiki.api.DeletedAttachment
Retrieve the original name of this attachment.
getFilesize() - Method in class com.xpn.xwiki.api.Attachment
 
getFirstObject(String) - Method in class com.xpn.xwiki.api.Document
 
getFormat() - Method in class com.xpn.xwiki.api.Document
 
getFullName() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getFullName() - Method in class com.xpn.xwiki.api.Document
Get the fullName of the document.
getFullNameSQL() - Method in class com.xpn.xwiki.api.XWiki
Deprecated.  
getGuid() - Method in class com.xpn.xwiki.api.Object
 
getHashMap() - Method in class com.xpn.xwiki.api.Util
Creates a HashMap, a generic map implementation optimized for performance.
getId() - Method in class com.xpn.xwiki.api.Attachment
 
getId() - Method in class com.xpn.xwiki.api.DeletedAttachment
Retrieve the internal entry index, used to uniquely identify this entity in the trash.
getId() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getId() - Method in class com.xpn.xwiki.api.Document
return the ID of the document.
getIncludedMacros() - Method in class com.xpn.xwiki.api.Document
 
getIncludedMacros(String, String) - Method in class com.xpn.xwiki.api.XWiki
Returns the list of Macros documents in the specified content
getIncludedPages() - Method in class com.xpn.xwiki.api.Document
 
getInterfaceLanguage() - Method in class com.xpn.xwiki.api.Context
Returns the interface language preference of the current user.
getInterfaceLanguagePreference() - Method in class com.xpn.xwiki.api.XWiki
API to access the interface language preference for the request Order of evaluation is: Language of the wiki in mono-lingual mode language request paramater language in context language user preference language in cookie language accepted by the navigator
getLanguage() - Method in class com.xpn.xwiki.api.Context
Returns the language of the current request.
getLanguage() - Method in class com.xpn.xwiki.api.DeletedDocument
 
getLanguage() - Method in class com.xpn.xwiki.api.Document
Get the language of the document.
getLanguagePreference() - Method in class com.xpn.xwiki.api.XWiki
First try to find the current language in use from the XWiki context.
getLastChanges() - Method in class com.xpn.xwiki.api.Document
 
getLinkedHashMap() - Method in class com.xpn.xwiki.api.Util
Creates a LinkedHashMap, a map implementation which preserves the order of insertion.
getLinkedPages() - Method in class com.xpn.xwiki.api.Document
 
getLinks() - Method in class com.xpn.xwiki.api.Document
 
getLinksAction() - Method in class com.xpn.xwiki.api.Context
Returns the action used by XWiki URL factories to replace the view action when creating URLs.
getLinksQueryString() - Method in class com.xpn.xwiki.api.Context
Returns the extra query string that is added to all the URLs created by XWiki URL factories.
getListValues() - Method in class com.xpn.xwiki.api.PropertyClass
If the property is a ListClass, returns the possible values.
getLocalUser() - Method in class com.xpn.xwiki.api.Context
Returns the current user which made the request.
getLocalUserName(String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a link to the User Name page displayed for the first name and last name of the user The link will link to the page on the local wiki even if the user is registered on a different wiki (in virtual wiki mode)
getLocalUserName(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a link to the User Name page displayed with a custom view The link will link to the page on the local wiki even if the user is registered on a different wiki (in virtual wiki mode) The formating is done using the format parameter which can contain velocity scripting and access all properties of the User profile using variables ($first_name $last_name $email $city)
getLocalUserName(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a text representing the user with the first name and last name of the user With the link param set to false it will not link to the user page With the link param set to true, the link will link to the page on the local wiki even if the user is registered on a different wiki (in virtual wiki mode)
getLocalUserName(String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a text representing the user with a custom view The formating is done using the format parameter which can contain velocity scripting and access all properties of the User profile using variables ($first_name $last_name $email $city) With the link param set to false it will not link to the user page With the link param set to true, the link will link to the page on the local wiki even if the user is registered on a different wiki (in virtual wiki mode)
getLocked() - Method in class com.xpn.xwiki.api.Document
 
getLockingDate() - Method in class com.xpn.xwiki.api.Document
 
getLockingUser() - Method in class com.xpn.xwiki.api.Document
 
getMacro() - Method in class com.xpn.xwiki.api.Context
Retrieves the information about the currently executing macro.
getMacroList() - Method in class com.xpn.xwiki.api.XWiki
API to get the macro list from the XWiki Preferences The macro list are the macros available from the Macro Mapping System
getMainWikiName() - Method in class com.xpn.xwiki.api.Context
Returns the name of the main wiki.
getMapValues() - Method in class com.xpn.xwiki.api.PropertyClass
If the property is a ListClass, returns the possible values as a map internal key <-> displayed value.
getMetaclass() - Method in class com.xpn.xwiki.api.XWiki
Get the global MetaClass object
getMetaDataDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getMimeType() - Method in class com.xpn.xwiki.api.Attachment
 
getMode() - Method in class com.xpn.xwiki.api.Context
Specifies the container or environment in which XWiki is currently running.
getName() - Method in class com.xpn.xwiki.api.Collection
 
getName() - Method in class com.xpn.xwiki.api.Document
return the name of a document.
getName() - Method in class com.xpn.xwiki.api.Element
Get the name of this element.
getNewline() - Method in class com.xpn.xwiki.api.Util
Get a New Line character.
getNull() - Method in class com.xpn.xwiki.api.Util
Get a Null value.
getNumber() - Method in class com.xpn.xwiki.api.Collection
 
getObject(String, String, String, boolean) - Method in class com.xpn.xwiki.api.Document
 
getObject(String, String, String) - Method in class com.xpn.xwiki.api.Document
 
getObject(String) - Method in class com.xpn.xwiki.api.Document
 
getObject(String, boolean) - Method in class com.xpn.xwiki.api.Document
get the object of the given className.
getObject(String, int) - Method in class com.xpn.xwiki.api.Document
 
getObjectDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getObjectFromRequest(String) - Method in class com.xpn.xwiki.api.XWiki
API to create an object from the request The parameters are the ones that are created from doc.display("field","edit") calls
getObjectNumbers(String) - Method in class com.xpn.xwiki.api.Document
 
getObjects(String) - Method in class com.xpn.xwiki.api.Document
 
getObjects(String, String, String) - Method in class com.xpn.xwiki.api.Document
Select a subset of objects from a given class, filtered on a "key = value" criteria.
getOriginalDatabase() - Method in class com.xpn.xwiki.api.Context
Returns the name of the original database.
getParent() - Method in class com.xpn.xwiki.api.Document
Get the name of the parent of this document.
getParentURL() - Method in class com.xpn.xwiki.api.Document
 
getPeriodFactory() - Method in class com.xpn.xwiki.api.CriteriaService
 
getPlainTitle() - Method in class com.xpn.xwiki.api.Document
 
getPlugin(String) - Method in class com.xpn.xwiki.api.XWiki
Returns a plugin from the plugin API.
getPrefixedFullName() - Method in class com.xpn.xwiki.api.Document
Get the complete fullName of the document.
getPrettyName() - Method in class com.xpn.xwiki.api.Collection
 
getPrettyName() - Method in class com.xpn.xwiki.api.PropertyClass
Get the untranslated user-friendly name of this property.
getPreviousDocument() - Method in class com.xpn.xwiki.api.Document
Allow to easily access the previous revision of a document
getPreviousVersion() - Method in class com.xpn.xwiki.api.Document
Get a string representing the previous version of the document.
getProperties() - Method in class com.xpn.xwiki.api.Class
 
getProperties() - Method in class com.xpn.xwiki.api.Collection
 
getProperty(String) - Method in class com.xpn.xwiki.api.Collection
 
getProperty() - Method in class com.xpn.xwiki.api.Property
 
getPropertyClass() - Method in class com.xpn.xwiki.api.PropertyClass
Provides access to the wrapped PropertyClass if Programming Rights are present.
getPropertyClassFromName(String) - Method in class com.xpn.xwiki.api.XWiki
API to get the Property object from a class based on a property path A property path looks like XWiki.ArticleClass_fieldname
getPropertyNames() - Method in class com.xpn.xwiki.api.Class
Returns a String table of the property names.
getPropertyNames() - Method in class com.xpn.xwiki.api.Collection
 
getQueryManager() - Method in class com.xpn.xwiki.api.XWiki
Deprecated. since XE 2.4M2 use the Query Manager Script Service
getRangeFactory() - Method in class com.xpn.xwiki.api.CriteriaService
 
getRCSVersion() - Method in class com.xpn.xwiki.api.Attachment
 
getRCSVersion() - Method in class com.xpn.xwiki.api.Document
Get a Version object representing the current version of the document.
getRealLanguage() - Method in class com.xpn.xwiki.api.Document
return the real language of the document
getRecentActions(String, int) - Method in class com.xpn.xwiki.api.StatsService
Returns the recently visited pages for a specific action.
getRecentRevisions() - Method in class com.xpn.xwiki.api.Document
 
getRecentRevisions(int) - Method in class com.xpn.xwiki.api.Document
 
getRefererStatistics(String, Scope, Period, Range) - Method in class com.xpn.xwiki.api.StatsService
Retrieves referrer statistics.
getRefererText(String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a viewable referer text for a referer Referers are URL where users have clicked on a link to an XWiki page Search engine referer URLs are transformed to a nicer view (Google: search query string) For other URL the http:// part is stripped
getRenderedContent() - Method in class com.xpn.xwiki.api.Document
 
getRenderedContent(String) - Method in class com.xpn.xwiki.api.Document
Deprecated. since 1.6M1 use Document.getRenderedContent(String, String)
getRenderedContent(String, String) - Method in class com.xpn.xwiki.api.Document
 
getRenderedContent(String, String, String) - Method in class com.xpn.xwiki.api.Document
 
getRenderedContent(Syntax) - Method in class com.xpn.xwiki.api.Document
 
getRenderedContentDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getRenderedTitle(String) - Method in class com.xpn.xwiki.api.Document
 
getRequest() - Method in class com.xpn.xwiki.api.Context
Returns the current request object.
getRequestURL() - Method in class com.xpn.xwiki.api.XWiki
API Allowing to access the current request URL being requested
getResponse() - Method in class com.xpn.xwiki.api.Context
Returns the current response object.
getRevisionCriteriaFactory() - Method in class com.xpn.xwiki.api.CriteriaService
 
getRevisionInfo(String) - Method in class com.xpn.xwiki.api.Document
Get information about a document version : author, date, etc.
getRevisions() - Method in class com.xpn.xwiki.api.Document
 
getRevisions(RevisionCriteria) - Method in class com.xpn.xwiki.api.Document
Get document versions matching criterias like author, minimum creation date, etc.
getScopeFactory() - Method in class com.xpn.xwiki.api.CriteriaService
 
getSectionEditingDepth() - Method in class com.xpn.xwiki.api.XWiki
 
getSectionIndex() - Method in class com.xpn.xwiki.api.DocumentSection
 
getSectionLevel() - Method in class com.xpn.xwiki.api.DocumentSection
 
getSectionNumber() - Method in class com.xpn.xwiki.api.DocumentSection
 
getSections() - Method in class com.xpn.xwiki.api.Document
Get the top sections contained in the document.
getSectionTitle() - Method in class com.xpn.xwiki.api.DocumentSection
 
getServletPath(String) - Method in class com.xpn.xwiki.api.XWiki
API to get the Servlet path for a given wiki.
getServletPath() - Method in class com.xpn.xwiki.api.XWiki
API to get the Servlet path for the current wiki.
getShortRefererText(String, int) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a viewable referer text for a referer with a maximum length Referers are URL where users have clicked on a link to an XWiki page Search engine referer URLs are transformed to a nicer view (Google: search query string) For other URL the http:// part is stripped
getSkin() - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the current skin for this request and user The skin is first derived from the request "skin" parameter If this parameter does not exist, the user preference "skin" is looked up If this parameter does not exist or is empty, the space preference "skin" is looked up If this parameter does not exist or is empty, the XWiki preference "skin" is looked up If this parameter does not exist or is empty, the xwiki.cfg parameter xwiki.defaultskin is looked up If this parameter does not exist or is empty, the xwiki.cfg parameter xwiki.defaultbaseskin is looked up If this parameter does not exist or is empty, the skin is "colibri"
getSkinFile(String) - Method in class com.xpn.xwiki.api.XWiki
Return the URL of the static file provided by the current skin The file is first looked in the skin active for the user, the space or the wiki.
getSkinFile(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
Return the URL of the static file provided by the current skin The file is first looked in the skin active for the user, the space or the wiki.
getSkinPreference(String) - Method in class com.xpn.xwiki.api.XWiki
API to access a Skin Preference The skin object is the current user's skin
getSkinPreference(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to access a Skin Preference The skin object is the current user's skin
getSpace() - Method in class com.xpn.xwiki.api.Document
return the name of the space of the document for example if the fullName of a document is "MySpace.Mydoc", the name is MySpace.
getSpaceCopyright() - Method in class com.xpn.xwiki.api.XWiki
API to access the copyright for this space.
getSpaceDocsName(String) - Method in class com.xpn.xwiki.api.XWiki
API to list all documents in a space
getSpacePreference(String) - Method in class com.xpn.xwiki.api.XWiki
API to access an Space Preference There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look in the XWiki Preferences
getSpacePreference(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to access an Space Preference There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look in the XWiki Preferences
getSpacePreferenceAsInt(String, int) - Method in class com.xpn.xwiki.api.XWiki
API to access a space Preference as a int number There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look for the XWiki Preference
getSpacePreferenceAsInt(String) - Method in class com.xpn.xwiki.api.XWiki
API to access a Space Preference as a int number There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look for the XWiki Preference
getSpacePreferenceAsLong(String, long) - Method in class com.xpn.xwiki.api.XWiki
API to access a Space Preference as a long number There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look for the XWiki Preference
getSpacePreferenceAsLong(String) - Method in class com.xpn.xwiki.api.XWiki
API to access a Space Preference as a long number There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look for the XWiki Preference
getSpacePreferenceFor(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to access an Space Preference There can be one preference object per language This function will find the right preference object associated to the current active language If no preference is found it will look in the XWiki Preferences
getSpacePreferenceFor(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference as a long number There can be one preference object per language This function will find the right preference object associated to the current active language
getSpaces() - Method in class com.xpn.xwiki.api.XWiki
API to list the current spaces in thiswiki
getStatsService() - Method in class com.xpn.xwiki.api.XWiki
Access statistics api
getSyntax() - Method in class com.xpn.xwiki.api.Document
 
getSyntaxId() - Method in class com.xpn.xwiki.api.Document
Deprecated. since 2.3M1 use Document.getSyntax() instead
getTagList() - Method in class com.xpn.xwiki.api.Document
 
getTags() - Method in class com.xpn.xwiki.api.Document
 
getTagsPossibleValues() - Method in class com.xpn.xwiki.api.Document
 
getTemplate() - Method in class com.xpn.xwiki.api.Document
 
getTextArea() - Method in class com.xpn.xwiki.api.Document
 
getTextArea(String) - Method in class com.xpn.xwiki.api.XWiki
Output content in the edit content textarea
getTimeDelta(long) - Method in class com.xpn.xwiki.api.Util
Compute the elapsed time, in milliseconds, since the specified unix-epoch timestamp.
getTitle() - Method in class com.xpn.xwiki.api.Document
Get the value of the title field of the document.
getTOC(int, int, boolean) - Method in class com.xpn.xwiki.api.Document
Returns data needed for a generation of Table of Content for this document.
getTooltip() - Method in class com.xpn.xwiki.api.PropertyClass
Get a tooltip string that should be displayed for input fields for instances of this property definition.
getTranslatedContent() - Method in class com.xpn.xwiki.api.Document
 
getTranslatedContent(String) - Method in class com.xpn.xwiki.api.Document
 
getTranslatedDocument(String) - Method in class com.xpn.xwiki.api.Document
 
getTranslatedDocument() - Method in class com.xpn.xwiki.api.Document
 
getTranslationList() - Method in class com.xpn.xwiki.api.Document
 
getTreeMap() - Method in class com.xpn.xwiki.api.Util
Creates a TreeMap, a map implementation which always maintains the natural order of the elements.
getType() - Method in class com.xpn.xwiki.api.PropertyClass
Get the actual type of the wrapped PropertyClass.
getUniquePageName(String) - Method in class com.xpn.xwiki.api.XWiki
Generates a unique page name based on initial page name and already existing pages
getUniquePageName(String, String) - Method in class com.xpn.xwiki.api.XWiki
Generates a unique page name based on initial page name and already existing pages
getURL() - Method in class com.xpn.xwiki.api.Document
Get the URL of this document.
getURL(String) - Method in class com.xpn.xwiki.api.Document
Get the URL to do a given action on this document.
getURL(String, String) - Method in class com.xpn.xwiki.api.Document
Get the URL to do a given action on this document.
getURL(String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of an a Wiki Document in view mode The URL is generated differently depending on the environement (Servlet, Portlet, PDF, etc..) The URL generation can be modified by implementing a new XWikiURLFactory object For compatibility with any target environement (and especially the portlet environment) It is important to always use the URL functions to generate URL and never hardcode URLs
getURL(DocumentReference) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of an a Wiki Document in view mode The URL is generated differently depending on the environement (Servlet, Portlet, PDF, etc..) The URL generation can be modified by implementing a new XWikiURLFactory object For compatibility with any target environement (and especially the portlet environment) It is important to always use the URL functions to generate URL and never hardcode URLs
getURL(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of an a Wiki Document in any mode.
getURL(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of a Wiki Document in any mode, optionally adding a query string The URL is generated differently depending on the environment (Servlet, Portlet, PDF, etc..) The URL generation can be modified by implementing a new XWikiURLFactory object.
getURL(DocumentReference, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of a Wiki Document in any mode, optionally adding a query string The URL is generated differently depending on the environment (Servlet, Portlet, PDF, etc..) The URL generation can be modified by implementing a new XWikiURLFactory object.
getURL(String, String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve the URL of an a Wiki Document in any mode, optionally adding an anchor.
getURLContent(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL protected using Basic Authentication
getURLContent(String) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL
getURLContent(String, String, String, int) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL protected using Basic Authentication
getURLContent(String, int) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL
getURLContentAsBytes(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL protected using Basic Authentication as Bytes
getURLContentAsBytes(String) - Method in class com.xpn.xwiki.api.XWiki
Returns the content of an HTTP/HTTPS URL as Bytes
getURLFactory() - Method in class com.xpn.xwiki.api.Context
Returns the URL factory matching both the protocol used to make the current request and the container or environment in which XWiki is running.
getUser() - Method in class com.xpn.xwiki.api.Context
Returns the current user which made the request.
getUser() - Method in class com.xpn.xwiki.api.User
Expose the wrapped XWikiUser object.
getUser() - Method in class com.xpn.xwiki.api.XWiki
 
getUser(String) - Method in class com.xpn.xwiki.api.XWiki
 
getUserName(String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a link to the User Name page displayed for the first name and last name of the user The link will link to the page on the wiki where the user is registered (in virtual wiki mode)
getUserName(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a link to the User Name page displayed with a custom view.
getUserName(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a text representing the user with the first name and last name of the user With the link param set to false it will not link to the user page With the link param set to true, the link will link to the page on the wiki where the user was registered (in virtual wiki mode)
getUserName(String, String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to retrieve a text representing the user with a custom view With the link param set to false it will not link to the user page With the link param set to true, the link will link to the page on the wiki where the user was registered (in virtual wiki mode) The formating is done using the format parameter which can contain velocity scripting and access all properties of the User profile using variables ($first_name $last_name $email $city)
getUserPreference(String) - Method in class com.xpn.xwiki.api.XWiki
API to access a User Preference This function will look in the User profile for the preference If no preference is found it will look in the Space Preferences If no preference is found it will look in the XWiki Preferences
getUserPreferenceFromCookie(String) - Method in class com.xpn.xwiki.api.XWiki
API to access a User Preference from cookie This function will look in the session cookie for the preference
getUserReference() - Method in class com.xpn.xwiki.api.Context
Returns the document reference for the profile page of the current user which made the request.
getUserTimeZone() - Method in class com.xpn.xwiki.api.XWiki
 
getUtil() - Method in class com.xpn.xwiki.api.Context
Deprecated. since 2.6M1 the functions provided by Util are internal, please do not use them.
getValidationMessage() - Method in class com.xpn.xwiki.api.PropertyClass
Get the message that should be displayed when a value for an instance of this property definition fails the validation.
getValidationRegExp() - Method in class com.xpn.xwiki.api.PropertyClass
Get the regular expression used for validating a value for an instance of this property definition.
getValidationScript() - Method in class com.xpn.xwiki.api.Document
Retrieves the validation script associated with this document, a Velocity script that is executed when validating the document data.
getValidationStatus() - Method in class com.xpn.xwiki.api.Context
Returns the form field validation status, which contains the exceptions or errors that may have occured during the validation process performed during a save.
getValue(String) - Method in class com.xpn.xwiki.api.Document
 
getValue(String, Object) - Method in class com.xpn.xwiki.api.Document
 
getValue() - Method in class com.xpn.xwiki.api.Property
 
getVersion() - Method in class com.xpn.xwiki.api.Attachment
 
getVersion() - Method in class com.xpn.xwiki.api.Document
Get a string representing the current version of the document.
getVersion() - Method in class com.xpn.xwiki.api.RevisionInfo
 
getVersion() - Method in class com.xpn.xwiki.api.XWiki
 
getVersionHashCode() - Method in class com.xpn.xwiki.api.Document
 
getVersionList() - Method in class com.xpn.xwiki.api.Attachment
 
getVersions() - Method in class com.xpn.xwiki.api.Attachment
 
getVisitStatistics(String, Period, Range) - Method in class com.xpn.xwiki.api.StatsService
Retrieves visit statistics.
getWeb() - Method in class com.xpn.xwiki.api.Document
Deprecated. use Document.getSpace() instead of this function.
getWebAppPath() - Method in class com.xpn.xwiki.api.XWiki
API to get the webapp path for the current wiki.
getWiki() - Method in class com.xpn.xwiki.api.Document
Get the name wiki where the document is stored.
getWysiwygToolbars() - Method in class com.xpn.xwiki.api.XWiki
API to check if using which toolbars in Wysiwyg editor
getXMLContent() - Method in class com.xpn.xwiki.api.Document
 
getXMLDiff(Document, Document) - Method in class com.xpn.xwiki.api.Document
 
getXObjects(List<BaseObject>) - Method in class com.xpn.xwiki.api.Document
 
getXWiki() - Method in class com.xpn.xwiki.api.Context
Returns the XWiki object.
getXWiki() - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to access the underlying main XWiki Object
getXWikiClass() - Method in class com.xpn.xwiki.api.Class
 
getxWikiClass() - Method in class com.xpn.xwiki.api.Collection
 
getxWikiClass() - Method in class com.xpn.xwiki.api.Document
 
getxWikiClasses() - Method in class com.xpn.xwiki.api.Document
 
getXWikiContext() - Method in class com.xpn.xwiki.api.Api
Get the current context.
getXWikiObject() - Method in class com.xpn.xwiki.api.Object
 
getxWikiObjects() - Method in class com.xpn.xwiki.api.Document
 
getXWikiPreference(String) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference There can be one preference object per language This function will find the right preference object associated to the current active language
getXWikiPreference(String, String) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference There can be one preference object per language This function will find the right preference object associated to the current active language
getXWikiPreferenceAsInt(String, int) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference as an int number There can be one preference object per language This function will find the right preference object associated to the current active language
getXWikiPreferenceAsInt(String) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference as a int number There can be one preference object per language This function will find the right preference object associated to the current active language
getXWikiPreferenceAsLong(String, long) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference as a long number There can be one preference object per language This function will find the right preference object associated to the current active language
getXWikiPreferenceAsLong(String) - Method in class com.xpn.xwiki.api.XWiki
API to access an XWiki Preference as a long number There can be one preference object per language This function will find the right preference object associated to the current active language

H

hasAccessLevel(String, String) - Method in class com.xpn.xwiki.api.Api
Check if the current user has an access level on a given document.
hasAccessLevel(String) - Method in class com.xpn.xwiki.api.Document
 
hasAccessLevel(String, String) - Method in class com.xpn.xwiki.api.Document
 
hasAccessLevel(String) - Method in class com.xpn.xwiki.api.XWiki
API to check rights on the current document for the current user
hasAccessLevel(String, String, String) - Method in class com.xpn.xwiki.api.XWiki
API to check rights on a document for a given user
hasAdminRights() - Method in class com.xpn.xwiki.api.Api
Check if the current user has administration rights either on the current wiki or on the current space.
hasBacklinks() - Method in class com.xpn.xwiki.api.XWiki
API to check if the backlinks feature is active Backlinks are activated in xwiki.cfg or in the XWiki Preferences
hasEditComment() - Method in class com.xpn.xwiki.api.XWiki
API to check if the edit comment feature is active Edit comments are activated in xwiki.cfg or in the XWiki Preferences
hasMinorEdit() - Method in class com.xpn.xwiki.api.XWiki
API to check if the minor edit feature is active minor edit is activated in xwiki.cfg or in the XWiki Preferences
hasProgrammingRights() - Method in class com.xpn.xwiki.api.Api
Check if the current document has programming rights, meaning that it was last saved by a user with the programming right globally granted.
hasRecycleBin() - Method in class com.xpn.xwiki.api.XWiki
API to check if the recycle bin feature is active recycle bin is activated in xwiki.cfg or in the XWiki Preferences
hasTags() - Method in class com.xpn.xwiki.api.XWiki
API to check if the tags feature is active.
hasWikiAdminRights() - Method in class com.xpn.xwiki.api.Api
Check if the current user has administration rights on the current wiki, regardless of any space admin rights that might also be available.

I

includeForm(String) - Method in class com.xpn.xwiki.api.XWiki
API to execute a form in the context of an including topic The rendering is evaluated in the context of the including topic All velocity variables are the one of the including topic This api is usually called using #includeForm in a page, which modifies the behavior of "Edit this page" button to direct for Form mode (inline)
includeForm(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to execute a form in the context of an including topic, optionnaly surrounding the content with {pre}{/pre} to avoid future wiki rendering The rendering is evaluated in the context of the including topic All velocity variables are the one of the including topic This api is usually called using #includeForm in a page, which modifies the behavior of "Edit this page" button to direct for Form mode (inline).
includeTopic(String) - Method in class com.xpn.xwiki.api.XWiki
API to include a topic into another The topic is rendered fully in the context of itself
includeTopic(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API to include a topic into another, optionally surrounding the content with {pre}{/pre} to avoid future wiki rendering.
insertText(String, String) - Method in class com.xpn.xwiki.api.Document
 
invokeServletAndReturnAsString(String) - Method in class com.xpn.xwiki.api.XWiki
Designed to include dynamic content, such as Servlets or JSPs, inside Velocity templates; works by creating a RequestDispatcher, buffering the output, then returning it as a string.
isAdvancedContent() - Method in class com.xpn.xwiki.api.Document
 
isCreator(String) - Method in class com.xpn.xwiki.api.Document
 
isCurrentLocalUserPage() - Method in class com.xpn.xwiki.api.Document
 
isCurrentUserCreator() - Method in class com.xpn.xwiki.api.Document
 
isCurrentUserPage() - Method in class com.xpn.xwiki.api.Document
 
isDisabled() - Method in class com.xpn.xwiki.api.PropertyClass
See if this property is disabled or not.
isEditCommentFieldHidden() - Method in class com.xpn.xwiki.api.XWiki
API to check if the edit comment field is shown in the edit form Edit comments are activated in xwiki.cfg or in the XWiki Preferences
isEditCommentMandatory() - Method in class com.xpn.xwiki.api.XWiki
API to check if the edit comment is mandatory (prompted by Javascript if empty) Edit comments are activated in xwiki.cfg or in the XWiki Preferences
isEditCommentSuggested() - Method in class com.xpn.xwiki.api.XWiki
API to check if the edit comment is suggested (prompted once by Javascript if empty) Edit comments are activated in xwiki.cfg or in the XWiki Preferences
isEnabled() - Method in class com.xpn.xwiki.api.StatsService
Deprecated. use StatsService.isEnabledForCurrentWiki()
isEnabledForCurrentWiki() - Method in class com.xpn.xwiki.api.StatsService
Indicate if statistics service is enabled for the current wiki.
isEnabledGlobally() - Method in class com.xpn.xwiki.api.StatsService
Indicate if statistics service is globally enabled.
isFromCache() - Method in class com.xpn.xwiki.api.Document
 
isImage() - Method in class com.xpn.xwiki.api.Attachment
 
isMain() - Method in class com.xpn.xwiki.api.User
See if the user is global (i.e.
isMainWiki() - Method in class com.xpn.xwiki.api.Context
Specifies if the current request was made to a virtual (non-main) wiki, or to the main wiki.
isMinorEdit() - Method in class com.xpn.xwiki.api.Document
 
isMinorEdit() - Method in class com.xpn.xwiki.api.RevisionInfo
 
isMostRecent() - Method in class com.xpn.xwiki.api.Document
 
isMultiLingual() - Method in class com.xpn.xwiki.api.XWiki
API to check is wiki is multi-lingual
isNew() - Method in class com.xpn.xwiki.api.Document
 
isProgrammaticContent() - Method in class com.xpn.xwiki.api.Document
 
isReadOnly() - Method in class com.xpn.xwiki.api.XWiki
returns true if xwiki.readonly is set in the configuration file
isTitleInCompatibilityMode() - Method in class com.xpn.xwiki.api.XWiki
 
isUserInGroup(String) - Method in class com.xpn.xwiki.api.User
Check if the user belongs to a group or not.
isVirtualMode() - Method in class com.xpn.xwiki.api.XWiki
API to check if wiki is in multi-wiki mode (virtual)

L

LOGGER - Static variable in class com.xpn.xwiki.api.User
Logging helper object.
LOGGER - Static variable in class com.xpn.xwiki.api.XWiki
Logging helper object.

N

newObject() - Method in class com.xpn.xwiki.api.Class
 
newObject(String) - Method in class com.xpn.xwiki.api.Document
 

O

Object - Class in com.xpn.xwiki.api
 
Object(BaseObject, XWikiContext) - Constructor for class com.xpn.xwiki.api.Object
 
outputImage(BufferedImage) - Method in class com.xpn.xwiki.api.Util
Output a BufferedImage object into the response outputstream.

P

parseBoolean(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to a Boolean object.
parseContent(String) - Method in class com.xpn.xwiki.api.XWiki
API allowing to parse a text content to evaluate velocity scripts
parseDouble(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to a primitive double.
parseFloat(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to a primitive float.
parseGroovyFromPage(String, String) - Method in class com.xpn.xwiki.api.XWiki
Privileged API to retrieve an object instantiated from groovy code in a String, using a classloader including all JAR files located in the passed page as attachments.
parseGroovyFromPage(String) - Method in class com.xpn.xwiki.api.XWiki
Privileged API to retrieve an object instanciated from groovy code in a String Groovy scripts compilation is cached
parseGroovyFromString(String) - Method in class com.xpn.xwiki.api.XWiki
Privileged API to retrieve an object instantiated from groovy code in a String.
parseInt(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to a primitive int.
parseInteger(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to an Integer object.
parseLong(String) - Method in class com.xpn.xwiki.api.Util
Convert a String to a primitive long.
parseTemplate(String) - Method in class com.xpn.xwiki.api.XWiki
API to parse a velocity template provided by the current Skin The template is first looked in the skin active for the user, the space or the wiki.
printStrackTrace(Throwable) - Method in class com.xpn.xwiki.api.Util
Get a stack trace as a String.
Property - Class in com.xpn.xwiki.api
Property is a single attribute of an XWiki Object.
Property(BaseProperty, XWikiContext) - Constructor for class com.xpn.xwiki.api.Property
The Constructor.
PropertyClass - Class in com.xpn.xwiki.api
XProperty definition API.
PropertyClass(PropertyClass, XWikiContext) - Constructor for class com.xpn.xwiki.api.PropertyClass
Default API constructor that creates a wrapper for a PropertyClass, given a context.
put(String, Object) - Method in class com.xpn.xwiki.api.Context
Puts an object on the context using the given key.

R

refreshLinks() - Method in class com.xpn.xwiki.api.XWiki
Priviledge API to regenerate the links/backlinks table Normally links and backlinks are stored when a page is modified This function will regenerate all the backlinks This function can be long to run
removeObject(Object) - Method in class com.xpn.xwiki.api.Document
Remove an XObject from the document.
removeObjects(String) - Method in class com.xpn.xwiki.api.Document
Remove all the objects of a given type (XClass) from the document.
rename(String) - Method in class com.xpn.xwiki.api.Document
Rename the current document and all the backlinks leading to it.
rename(DocumentReference) - Method in class com.xpn.xwiki.api.Document
Rename the current document and all the backlinks leading to it.
rename(String, List<String>) - Method in class com.xpn.xwiki.api.Document
Rename the current document and all the links pointing to it in the list of passed backlink documents.
rename(String, List<String>, List<String>) - Method in class com.xpn.xwiki.api.Document
Same as Document.rename(String, List) but the list of documents having the current document as their parent is passed in parameter.
rename(DocumentReference, List<DocumentReference>, List<DocumentReference>) - Method in class com.xpn.xwiki.api.Document
Same as Document.rename(String, List) but the list of documents having the current document as their parent is passed in parameter.
renameDocument(String) - Method in class com.xpn.xwiki.api.Document
Deprecated. use Document.rename(String) instead
renameDocument(String, List<String>) - Method in class com.xpn.xwiki.api.Document
Deprecated. use Document.rename(String, java.util.List) instead
renamePage(Document, String) - Method in class com.xpn.xwiki.api.XWiki
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
renderChunk(Chunk, Document) - Method in class com.xpn.xwiki.api.XWiki
API to render a chunk (difference between two versions
renderChunk(Chunk, boolean, Document) - Method in class com.xpn.xwiki.api.XWiki
API to render a chunk (difference between two versions
renderTemplate(String) - Method in class com.xpn.xwiki.api.XWiki
API to render a velocity template provided by the current Skin The template is first looked in the skin active for the user, the space or the wiki.
renderText(String, Document) - Method in class com.xpn.xwiki.api.XWiki
API to render a text in the context of a document
resetRenderingEngine() - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to reset the rendenring engine This would restore the rendering engine evaluation loop and take into account new configuration parameters
reverseList(List<T>) - Method in class com.xpn.xwiki.api.Util
Reverse the order of the elements within a list, so that the last element is moved to the beginning of the list, the next-to-last element to the second position, and so on.
RevisionInfo - Class in com.xpn.xwiki.api
API object for get info about some version of Document.
RevisionInfo(XWikiRCSNodeInfo, XWikiContext) - Constructor for class com.xpn.xwiki.api.RevisionInfo
 

S

save() - Method in class com.xpn.xwiki.api.Document
 
save(String) - Method in class com.xpn.xwiki.api.Document
 
save(String, boolean) - Method in class com.xpn.xwiki.api.Document
 
saveAsAuthor() - Method in class com.xpn.xwiki.api.Document
Save the document if the content author of the script calling this method has permission to do so.
saveAsAuthor(String) - Method in class com.xpn.xwiki.api.Document
Save the document if the content author of the script calling this method has permission to do so.
saveAsAuthor(String, boolean) - Method in class com.xpn.xwiki.api.Document
Save the document if the content author of the script calling this method has permission to do so.
saveDocument(String, boolean) - Method in class com.xpn.xwiki.api.Document
 
saveWithProgrammingRights() - Method in class com.xpn.xwiki.api.Document
 
saveWithProgrammingRights(String) - Method in class com.xpn.xwiki.api.Document
 
saveWithProgrammingRights(String, boolean) - Method in class com.xpn.xwiki.api.Document
 
search(String) - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to run a search on the database returning a list of data This search is send to the store engine (Hibernate HQL, JCR XPATH or other)
search(String, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to run a search on the database returning a list of data.
search(String, int, int) - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to run a search on the database returning a list of data.
search(String, int, int, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to run a search on the database returning a list of data.
searchDocuments(String) - Method in class com.xpn.xwiki.api.XWiki
API allowing to search for document names matching a query.
searchDocuments(String, int, int) - Method in class com.xpn.xwiki.api.XWiki
API allowing to search for document names matching a query return only a limited number of elements and skipping the first rows.
searchDocuments(String, int, int, String) - Method in class com.xpn.xwiki.api.XWiki
Privileged API allowing to search for document names matching a query return only a limited number of elements and skipping the first rows.
searchDocuments(String, boolean) - Method in class com.xpn.xwiki.api.XWiki
API allowing to search for documents allowing to have mutliple entries per language
searchDocuments(String, boolean, int, int) - Method in class com.xpn.xwiki.api.XWiki
API allowing to search for documents allowing to have multiple entries per language
searchDocuments(String, int, int, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Search documents by passing HQL where clause values as parameters.
searchDocuments(String, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Same as XWiki.searchDocuments(String, int, int, java.util.List) but returns all rows.
searchDocumentsNames(String, String, int, int, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Search documents in the provided wiki by passing HQL where clause values as parameters.
searchSpacesNames(String, int, int, List<?>) - Method in class com.xpn.xwiki.api.XWiki
Search spaces by passing HQL where clause values as parameters.
sendConfirmationMail(String, String, String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to send a confirmation email to a user
sendConfirmationMail(String, String, String, String) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to send a confirmation email to a user
set(String, Object) - Method in class com.xpn.xwiki.api.Document
 
set(String, Object, Object) - Method in class com.xpn.xwiki.api.Document
 
set(String, Object) - Method in class com.xpn.xwiki.api.Object
 
setCacheDuration(int) - Method in class com.xpn.xwiki.api.Context
Sets the cache duration in seconds.
setComment(String) - Method in class com.xpn.xwiki.api.Document
 
setContent(String) - Method in class com.xpn.xwiki.api.Document
 
setCustomClass(String) - Method in class com.xpn.xwiki.api.Document
 
setDatabase(String) - Method in class com.xpn.xwiki.api.Context
Sets the current database.
setDefaultTemplate(String) - Method in class com.xpn.xwiki.api.Document
 
setDisplayMode(String) - Method in class com.xpn.xwiki.api.Context
Sets the default field display mode, when using Document.display(String) or Document.display(String, Object).
setDoc(XWikiDocument) - Method in class com.xpn.xwiki.api.Context
Sets the current document.
setFinished(boolean) - Method in class com.xpn.xwiki.api.Context
Specifies if the current page should be sent to the client or not.
setGuid(String) - Method in class com.xpn.xwiki.api.Object
 
setLinksAction(String) - Method in class com.xpn.xwiki.api.Context
Sets the action to be used instead of the view action inside URLs.
setLinksQueryString(String) - Method in class com.xpn.xwiki.api.Context
Sets an extra query string to be added to all the URLs created by XWiki URL factories.
setMinorEdit(boolean) - Method in class com.xpn.xwiki.api.Document
 
setParent(String) - Method in class com.xpn.xwiki.api.Document
 
setReadOnly(boolean) - Method in class com.xpn.xwiki.api.XWiki
Privileged API to set/unset the readonly status of the Wiki After setting this to true no writing to the database will be performed All Edit buttons will be removed and save actions disabled This is used for maintenance purposes
setSectionIndex(int) - Method in class com.xpn.xwiki.api.DocumentSection
 
setSectionLevel(String) - Method in class com.xpn.xwiki.api.DocumentSection
 
setSectionNumber(int) - Method in class com.xpn.xwiki.api.DocumentSection
 
setSectionTitle(String) - Method in class com.xpn.xwiki.api.DocumentSection
 
setSyntax(Syntax) - Method in class com.xpn.xwiki.api.Document
 
setSyntaxId(String) - Method in class com.xpn.xwiki.api.Document
 
setTitle(String) - Method in class com.xpn.xwiki.api.Document
 
setValidationScript(String) - Method in class com.xpn.xwiki.api.Document
Sets a new validation script for this document, a Velocity script that is executed when validating the document data.
sort(List<T>) - Method in class com.xpn.xwiki.api.Util
Sort a list using a standard comparator.
split(String, String) - Method in class com.xpn.xwiki.api.Util
Split a text into an array of texts, according to a list of separator characters.
StatsService - Class in com.xpn.xwiki.api
Statistics api.
StatsService(XWikiContext) - Constructor for class com.xpn.xwiki.api.StatsService
Create new StatsService instance.

T

toNumber(Object) - Method in class com.xpn.xwiki.api.Util
Convert an Object to a number and return null if the object is not a Number.
toString() - Method in class com.xpn.xwiki.api.Document
toXML() - Method in class com.xpn.xwiki.api.Document
 
toXMLDocument() - Method in class com.xpn.xwiki.api.Document
 

U

unsetLinksAction() - Method in class com.xpn.xwiki.api.Context
Stops the view action from being replaced with another action inside URLs.
unsetLinksQueryString() - Method in class com.xpn.xwiki.api.Context
Specifies that no additional query string should be added to XWiki URLs.
updateObjectFromRequest(String) - Method in class com.xpn.xwiki.api.Document
 
updateObjectFromRequest(String, String) - Method in class com.xpn.xwiki.api.Document
 
updateObjectsFromRequest(String) - Method in class com.xpn.xwiki.api.Document
 
updateObjectsFromRequest(String, String) - Method in class com.xpn.xwiki.api.Document
 
use(Object) - Method in class com.xpn.xwiki.api.Document
 
use(String) - Method in class com.xpn.xwiki.api.Document
 
use(String, int) - Method in class com.xpn.xwiki.api.Document
 
User - Class in com.xpn.xwiki.api
Scriptable API for easy handling of users.
User(XWikiUser, XWikiContext) - Constructor for class com.xpn.xwiki.api.User
Constructs a wrapper for the given protected XWikiUser object.
Util - Class in com.xpn.xwiki.api
Utility APIs, available to scripting environments under the util variable.
Util(XWiki, XWikiContext) - Constructor for class com.xpn.xwiki.api.Util
Simple constructor, initializes a new utility API with the current context and the current global XWiki object.

V

validate() - Method in class com.xpn.xwiki.api.Document
 
validate(String[]) - Method in class com.xpn.xwiki.api.Document
 
validateUser(boolean) - Method in class com.xpn.xwiki.api.XWiki
Priviledged API to validate the return code given by a user in response to an email validation email The validation information are taken from the request object

W

wrapDocs(List<?>) - Method in class com.xpn.xwiki.api.XWiki
Function to wrap a list of XWikiDocument into Document objects

X

XWiki - Class in com.xpn.xwiki.api
 
XWiki(XWiki, XWikiContext) - Constructor for class com.xpn.xwiki.api.XWiki
XWiki API Constructor

A C D E F G H I L N O P R S T U V W X

Copyright © 2004-2011 XWiki. All Rights Reserved.