com.xpn.xwiki.wysiwyg.client
Interface WikiService

All Superinterfaces:

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

All Known Implementing Classes:

DefaultWikiService

@ComponentRole
@RemoteServiceRelativePath(value="WikiService.gwtrpc")
public interface WikiService
extends com.google.gwt.user.client.rpc.RemoteService

The service interface used on the server.

NOTE: This component interface should be split in multiple domain specific interfaces. Don't add any more methods!

Version:

$Id: WikiService.java 25780 2009-12-14 09:41:47Z mflorea $

Method Summary

Attachment	getAttachment(java.lang.String wikiName, java.lang.String spaceName, java.lang.String pageName, java.lang.String attachmentName) Returns attachment information from the passed parameters, testing if the passed attachment exists.
java.util.List<Attachment>	getAttachments(java.lang.String wikiName, java.lang.String spaceName, java.lang.String pageName) Returns all the attachments from the referred page.
java.util.List<Attachment>	getImageAttachments(java.lang.String wikiName, java.lang.String spaceName, java.lang.String pageName) Returns all the image attachments from the referred page.
java.util.List<WikiPage>	getMatchingPages(java.lang.String keyword, int start, int count)
LinkConfig	getPageLink(java.lang.String wikiName, java.lang.String spaceName, java.lang.String pageName, java.lang.String revision, java.lang.String anchor) Creates a page link (URL, reference) from the given parameters.
java.util.List<java.lang.String>	getPageNames(java.lang.String wikiName, java.lang.String spaceName)
java.util.List<WikiPage>	getRecentlyModifiedPages(int start, int count)
java.util.List<java.lang.String>	getSpaceNames(java.lang.String wikiName)
java.util.List<java.lang.String>	getVirtualWikiNames()
java.lang.Boolean	isMultiWiki() Check if the current wiki is part of a multiwiki (i.e.

Method Detail

isMultiWiki

java.lang.Boolean isMultiWiki()

Check if the current wiki is part of a multiwiki (i.e. this is a virtual wiki).

Returns:

true if the current wiki is a multiwiki, and false in the other case

getVirtualWikiNames

java.util.List<java.lang.String> getVirtualWikiNames()

Returns:

a list containing the names of all wikis.

getSpaceNames

java.util.List<java.lang.String> getSpaceNames(java.lang.String wikiName)

Parameters:

wikiName - the name of the wiki to search for spaces. If this is null, the current wiki will be used.

Returns:

a list of all spaces names in the specified wiki.

getPageNames

java.util.List<java.lang.String> getPageNames(java.lang.String wikiName,
                                              java.lang.String spaceName)

Parameters:

wikiName - the name of the wiki. Pass null if this should use the current wiki.

spaceName - the name of the space

Returns:

the list of the page names from a given space and a given wiki.

getRecentlyModifiedPages

java.util.List<WikiPage> getRecentlyModifiedPages(int start,
                                                  int count)

Parameters:

start - the start index of the list of pages to return

count - the number of pages to return

Returns:

the recently count modified pages of the current user, starting from position start

getMatchingPages

java.util.List<WikiPage> getMatchingPages(java.lang.String keyword,
                                          int start,
                                          int count)

Parameters:

start - the start index of the list of pages to return

count - the number of pages to return

keyword - the keyword to search the pages for

Returns:

the count pages whose full name or title match the keyword, starting from position start

getPageLink

LinkConfig getPageLink(java.lang.String wikiName,
                       java.lang.String spaceName,
                       java.lang.String pageName,
                       java.lang.String revision,
                       java.lang.String anchor)

Creates a page link (URL, reference) from the given parameters. None of them are mandatory, if one misses, it is replaced with a default value.

Parameters:

wikiName - the name of the wiki to which to link

spaceName - the name of the space of the page. If this parameter is missing, it is replaced with the space of the current document in the context.

pageName - the name of the page to which to link to. If it's missing, it is replaced with "WebHome".

revision - the value for the page revision to which to link to. If this is missing, the link is made to the latest revision, the default view action for the document.

anchor - the name of the anchor type.

Returns:

the data of the link to the document, containing link url and link reference information.

getAttachment

Attachment getAttachment(java.lang.String wikiName,
                         java.lang.String spaceName,
                         java.lang.String pageName,
                         java.lang.String attachmentName)

Returns attachment information from the passed parameters, testing if the passed attachment exists. Note that the attachmentName name will be cleaned to match the attachment names cleaning rules, and the attachment reference and URL will be generated with the cleaned name. This function will be used as a method to test the correct upload of a file to a page.

Parameters:

wikiName - the name of the wiki of the page the file is attached to

spaceName - the name of the space of the page the file is attached to

pageName - the name of the page the file is attached to

attachmentName - the uncleaned name of the attachment, which is to be cleaned on the server

Returns:

an Attachment containing the reference and the URL of the attachment, or null in case the attachment was not found

getImageAttachments

java.util.List<Attachment> getImageAttachments(java.lang.String wikiName,
                                               java.lang.String spaceName,
                                               java.lang.String pageName)

Returns all the image attachments from the referred page.

Parameters:

wikiName - the name of the wiki to get images from

spaceName - the name of the space to get image attachments from

pageName - the name of the page to get image attachments from

Returns:

list of the image attachments

getAttachments

java.util.List<Attachment> getAttachments(java.lang.String wikiName,
                                          java.lang.String spaceName,
                                          java.lang.String pageName)

Returns all the attachments from the referred page.

Parameters:

wikiName - the name of the wiki to get attachments from

spaceName - the name of the space to get attachments from

pageName - the name of the page to get attachments from

Returns:

list of the attachments