com.xpn.xwiki.gwt.api.client
Interface XWikiService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

XWikiServiceImpl

public interface XWikiService
extends com.google.gwt.user.client.rpc.RemoteService

Nested Class Summary

static class

XWikiService.App Utility/Convinience class.

Method Summary

boolean	addComment(String docname, String message)
List	addObject(String fullName, List classesName)
XObject	addObject(String fullName, String className)
boolean	addObject(String docname, XObject xobject)
List	customQuery(String queryPage)
List	customQuery(String queryPage, int nb, int start)
List	customQuery(String queryPage, Map params)
List	customQuery(String queryPage, Map params, int nb, int start)
Boolean	deleteDocument(String docName)
int	deleteDocuments(String sql)
Boolean	deleteObject(String docName, String className, int number)
Boolean	deleteObject(XObject object)
Document	getDocument(String fullName)
Document	getDocument(String fullName, boolean withObject, boolean withRenderedContent)
Document	getDocument(String fullName, boolean full, boolean viewDisplayers, boolean editDisplayers)
Document	getDocument(String fullName, boolean withObject, boolean viewDisplayers, boolean editDisplayers, boolean withRenderedContent)
String	getDocumentContent(String fullName)
String	getDocumentContent(String fullName, boolean rendered)
String	getDocumentContent(String fullName, boolean rendered, Map params)
List	getDocuments(String sql, int nb, int start)
List	getDocuments(String sql, int nb, int start, boolean fullName)
List	getDocuments(String sql, int nb, int start, boolean fullName, boolean viewDisplayers, boolean editDisplayers)
List	getDocumentVersions(String pageName, int nb, int start)
XObject	getFirstObject(String sql, String className)
String	getLoginURL()
List	getObjects(String sql, String className, int nb, int start)
Dictionary	getTranslation(String translationPage, String local)
Document	getUniqueDocument(String space)
Document	getUniqueDocument(String space, String pageName)
String	getUniquePageName(String space)
String	getUniquePageName(String space, String pageName)
User	getUser()
User	getUser(String fullName)
User[]	getUserList(int nb, int start)
Boolean	hasAccessLevel(String level, String docName) Checks the access level for the current user on the specified document.
Boolean	hasAccessLevel(String level, String username, String docName) Checks the access level for the user given by username on the specified document.
Boolean	isLastDocumentVersion(String fullName, String version)
Boolean	lockDocument(String fullName, boolean force)
String	login(String username, String password, boolean rememberme)
void	logJSError(Map infos)
Boolean	saveDocumentContent(String fullName, String content)
Boolean	saveObject(XObject object)
Boolean	saveObjects(List objects)
List	searchDocuments(String sql, int nb, int start)
void	unlockDocument(String fullName)
boolean	updateProperty(String docname, String className, String propertyname, int value)
boolean	updateProperty(String docname, String className, String propertyname, List value)
boolean	updateProperty(String docname, String className, String propertyname, String value)

Method Detail

getDocument

Document getDocument(String fullName)
                     throws XWikiGWTException

Throws:

XWikiGWTException

getDocument

Document getDocument(String fullName,
                     boolean withObject,
                     boolean withRenderedContent)
                     throws XWikiGWTException

Throws:

XWikiGWTException

getDocument

Document getDocument(String fullName,
                     boolean full,
                     boolean viewDisplayers,
                     boolean editDisplayers)
                     throws XWikiGWTException

Throws:

XWikiGWTException

getDocument

Document getDocument(String fullName,
                     boolean withObject,
                     boolean viewDisplayers,
                     boolean editDisplayers,
                     boolean withRenderedContent)
                     throws XWikiGWTException

Throws:

XWikiGWTException

deleteDocument

Boolean deleteDocument(String docName)
                       throws XWikiGWTException

Throws:

XWikiGWTException

deleteDocuments

int deleteDocuments(String sql)
                    throws XWikiGWTException

Throws:

XWikiGWTException

getUniquePageName

String getUniquePageName(String space)
                         throws XWikiGWTException

Throws:

XWikiGWTException

getUniquePageName

String getUniquePageName(String space,
                         String pageName)
                         throws XWikiGWTException

Throws:

XWikiGWTException

getUniqueDocument

Document getUniqueDocument(String space,
                           String pageName)
                           throws XWikiGWTException

Throws:

XWikiGWTException

getUniqueDocument

Document getUniqueDocument(String space)
                           throws XWikiGWTException

Throws:

XWikiGWTException

getUser

User getUser(String fullName)
             throws XWikiGWTException

Throws:

XWikiGWTException

getUser

User getUser()
             throws XWikiGWTException

Throws:

XWikiGWTException

getUserList

User[] getUserList(int nb,
                   int start)
                   throws XWikiGWTException

Throws:

XWikiGWTException

updateProperty

boolean updateProperty(String docname,
                       String className,
                       String propertyname,
                       String value)
                       throws XWikiGWTException

Throws:

XWikiGWTException

updateProperty

boolean updateProperty(String docname,
                       String className,
                       String propertyname,
                       int value)
                       throws XWikiGWTException

Throws:

XWikiGWTException

updateProperty

boolean updateProperty(String docname,
                       String className,
                       String propertyname,
                       List value)
                       throws XWikiGWTException

Throws:

XWikiGWTException

searchDocuments

List searchDocuments(String sql,
                     int nb,
                     int start)
                     throws XWikiGWTException

Throws:

XWikiGWTException

getDocuments

List getDocuments(String sql,
                  int nb,
                  int start)
                  throws XWikiGWTException

Throws:

XWikiGWTException

getDocuments

List getDocuments(String sql,
                  int nb,
                  int start,
                  boolean fullName)
                  throws XWikiGWTException

Throws:

XWikiGWTException

getDocuments

List getDocuments(String sql,
                  int nb,
                  int start,
                  boolean fullName,
                  boolean viewDisplayers,
                  boolean editDisplayers)
                  throws XWikiGWTException

Throws:

XWikiGWTException

getObjects

List getObjects(String sql,
                String className,
                int nb,
                int start)
                throws XWikiGWTException

Throws:

XWikiGWTException

getFirstObject

XObject getFirstObject(String sql,
                       String className)
                       throws XWikiGWTException

Throws:

XWikiGWTException

addObject

XObject addObject(String fullName,
                  String className)
                  throws XWikiGWTException

Throws:

XWikiGWTException

addObject

List addObject(String fullName,
               List classesName)
               throws XWikiGWTException

Throws:

XWikiGWTException

addObject

boolean addObject(String docname,
                  XObject xobject)
                  throws XWikiGWTException

Throws:

XWikiGWTException

lockDocument

Boolean lockDocument(String fullName,
                     boolean force)
                     throws XWikiGWTException

Throws:

XWikiGWTException

unlockDocument

void unlockDocument(String fullName)
                    throws XWikiGWTException

Throws:

XWikiGWTException

isLastDocumentVersion

Boolean isLastDocumentVersion(String fullName,
                              String version)
                              throws XWikiGWTException

Throws:

XWikiGWTException

login

String login(String username,
             String password,
             boolean rememberme)
             throws XWikiGWTException

Throws:

XWikiGWTException

getLoginURL

String getLoginURL()
                   throws XWikiGWTException

Throws:

XWikiGWTException

saveDocumentContent

Boolean saveDocumentContent(String fullName,
                            String content)
                            throws XWikiGWTException

Throws:

XWikiGWTException

saveObject

Boolean saveObject(XObject object)
                   throws XWikiGWTException

Throws:

XWikiGWTException

saveObjects

Boolean saveObjects(List objects)
                    throws XWikiGWTException

Throws:

XWikiGWTException

deleteObject

Boolean deleteObject(XObject object)
                     throws XWikiGWTException

Throws:

XWikiGWTException

deleteObject

Boolean deleteObject(String docName,
                     String className,
                     int number)
                     throws XWikiGWTException

Throws:

XWikiGWTException

addComment

boolean addComment(String docname,
                   String message)
                   throws XWikiGWTException

Throws:

XWikiGWTException

customQuery

List customQuery(String queryPage)
                 throws XWikiGWTException

Throws:

XWikiGWTException

customQuery

List customQuery(String queryPage,
                 int nb,
                 int start)
                 throws XWikiGWTException

Throws:

XWikiGWTException

customQuery

List customQuery(String queryPage,
                 Map params)
                 throws XWikiGWTException

Throws:

XWikiGWTException

customQuery

List customQuery(String queryPage,
                 Map params,
                 int nb,
                 int start)
                 throws XWikiGWTException

Throws:

XWikiGWTException

getDocumentContent

String getDocumentContent(String fullName)
                          throws XWikiGWTException

Throws:

XWikiGWTException

getDocumentContent

String getDocumentContent(String fullName,
                          boolean rendered)
                          throws XWikiGWTException

Throws:

XWikiGWTException

getDocumentContent

String getDocumentContent(String fullName,
                          boolean rendered,
                          Map params)
                          throws XWikiGWTException

Throws:

XWikiGWTException

getDocumentVersions

List getDocumentVersions(String pageName,
                         int nb,
                         int start)
                         throws XWikiGWTException

Throws:

XWikiGWTException

hasAccessLevel

Boolean hasAccessLevel(String level,
                       String docName)
                       throws XWikiGWTException

Checks the access level for the current user on the specified document.

Parameters:

level - level to verify access for, e.g.: "view", "edit"

docName - fullname of the document to check access level for, e.g. Main.WebHome

Returns:

true if current user has specified access level on the specified document, false otherwise

Throws:

XWikiGWTException

hasAccessLevel

Boolean hasAccessLevel(String level,
                       String username,
                       String docName)
                       throws XWikiGWTException

Checks the access level for the user given by username on the specified document.

Parameters:

level - level to verify access for, e.g.: "view", "edit"

username - fullname of the user to check access for, e.g. XWiki.User

docName - fullname of the document to check access level for, e.g. Main.WebHome

Returns:

true if specified user has the access level on the specified document, false otherwise

Throws:

XWikiGWTException

logJSError

void logJSError(Map infos)
                throws XWikiGWTException

Throws:

XWikiGWTException

getTranslation

Dictionary getTranslation(String translationPage,
                          String local)
                          throws XWikiGWTException

Throws:

XWikiGWTException