org.exoplatform.wiki.service

Interface WikiService

public interface WikiService

Provides functions for processing database with wikis and pages, including: adding, editing, removing and searching for data.

Level API:

Provisional

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachmentToPage(org.exoplatform.wiki.mow.api.Attachment attachment, org.exoplatform.wiki.mow.api.Page page) Add the given attachment to the given page
void	addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Registers a component plugin into the Wiki service.
void	addEmotionIconsPlugin(org.exoplatform.wiki.plugin.WikiEmotionIconsPlugin plugin) Adds a Wiki emotion icons as plugin.
void	addPageLink(org.exoplatform.wiki.service.WikiPageParams param, org.exoplatform.wiki.service.WikiPageParams entity) Add a link between 2 pages
void	addRelatedPage(org.exoplatform.wiki.service.WikiPageParams orginaryPageParams, org.exoplatform.wiki.service.WikiPageParams relatedPageParams) Adds a related page to the current wiki page.
void	addWatcherToPage(String username, org.exoplatform.wiki.mow.api.Page page) Add the given user as watcher of the wiki page
void	addWikiTemplatePagePlugin(org.exoplatform.wiki.plugin.WikiTemplatePagePlugin templatePlugin) Adds a Wiki template as plugin.
boolean	canModifyPagePermission(org.exoplatform.wiki.mow.api.Page currentPage, String currentUser) Check if the given user can update the page
boolean	canPublicAndRetrictPage(org.exoplatform.wiki.mow.api.Page currentPage, String currentUser) Check if the given user can public or restrict the page
org.exoplatform.wiki.mow.api.DraftPage	createDraftForExistPage(org.exoplatform.wiki.mow.api.DraftPage draftPage, org.exoplatform.wiki.mow.api.Page targetPage, String revision, long clientTime) Creates a draft page for a wiki page which is specified by a given param object.
org.exoplatform.wiki.mow.api.DraftPage	createDraftForNewPage(org.exoplatform.wiki.mow.api.DraftPage draftPage, org.exoplatform.wiki.mow.api.Page parentPage, long clientTime) Creates a draft page for a new wiki page whose parent is specified by a given param object.
void	createEmotionIcon(org.exoplatform.wiki.mow.api.EmotionIcon emotionIcon) Creates a emotion icon
org.exoplatform.wiki.mow.api.Page	createPage(org.exoplatform.wiki.mow.api.Wiki wiki, String parentPageName, org.exoplatform.wiki.mow.api.Page page) Create a new wiki page in the given wiki, under the given parent page.
void	createTemplatePage(org.exoplatform.wiki.mow.api.Wiki wiki, org.exoplatform.wiki.mow.api.Template template) Creates a new Wiki template.
void	createVersionOfPage(org.exoplatform.wiki.mow.api.Page page) Creates a version of a page.
org.exoplatform.wiki.mow.api.Wiki	createWiki(String wikiType, String owner) Creates a wiki with the given type and owner
void	deleteAttachmentOfPage(String attachmentId, org.exoplatform.wiki.mow.api.Page page) Deletes the given attachment of the given page
boolean	deletePage(String wikiType, String wikiOwner, String pageId) Deletes a wiki page.
void	deleteTemplatePage(String wikiType, String wikiOwner, String templateName) Deletes a Wiki template.
void	deleteWatcherOfPage(String username, org.exoplatform.wiki.mow.api.Page page) Delete a user as watcher of the given page
List<org.exoplatform.wiki.service.listener.AttachmentWikiListener>	getAttachmentListeners() Gets attachment listeners that are registered into the Wiki service.
org.exoplatform.wiki.mow.api.Attachment	getAttachmentOfPageByName(String attachmentName, org.exoplatform.wiki.mow.api.Page page) Get a attachment of a ther given page by name
List<org.exoplatform.wiki.mow.api.Attachment>	getAttachmentsOfPage(org.exoplatform.wiki.mow.api.Page page) Gets attachments of the given page
List<org.exoplatform.wiki.service.BreadcrumbData>	getBreadcumb(String wikiType, String wikiOwner, String pageId) Gets a list of data which is used for composing the breadcrumb.
List<org.exoplatform.wiki.mow.api.Page>	getChildrenPageOf(org.exoplatform.wiki.mow.api.Page page) Get all the children pages of a wiki page
String	getDefaultWikiSyntaxId() Gets Id of a default Wiki syntax.
org.exoplatform.wiki.mow.api.DraftPage	getDraft(String draftName) Gets a draft page by its name.
org.exoplatform.wiki.service.diff.DiffResult	getDraftChanges(org.exoplatform.wiki.mow.api.DraftPage draftPage) Gets the changes between the draft page and the target page
org.exoplatform.wiki.mow.api.DraftPage	getDraftOfPage(org.exoplatform.wiki.mow.api.Page page) Gets a draft page of a wiki page which is specified by a given param object.
List<org.exoplatform.wiki.mow.api.DraftPage>	getDraftsOfUser(String username) Gets a list of draft pages belonging to a given user.
List<org.exoplatform.wiki.mow.api.Page>	getDuplicatePages(org.exoplatform.wiki.mow.api.Page parentPage, org.exoplatform.wiki.mow.api.Wiki targetWiki, List<org.exoplatform.wiki.mow.api.Page> resultList) Checks if a page and its children are duplicated with ones in the target Wiki or not, then gets a list of duplicated pages if any.
long	getEditPageLivingTime() Get the living time of edited page
org.exoplatform.wiki.mow.api.EmotionIcon	getEmotionIconByName(String name) Gets an emotion icon by name
List<org.exoplatform.wiki.mow.api.EmotionIcon>	getEmotionIcons() Gets all the emotion icons
org.exoplatform.wiki.mow.api.Page	getExsitedOrNewDraftPageById(String wikiType, String wikiOwner, String pageId) Gets a wiki page or its draft if existing by its Id.
org.exoplatform.wiki.mow.api.Page	getHelpSyntaxPage(String syntaxId, boolean fullContent) Gets a Help wiki page based on a given syntax Id.
org.exoplatform.wiki.mow.api.DraftPage	getLastestDraft() Gets the last created draft of a wiki page.
int	getNbOfAttachmentsOfPage(org.exoplatform.wiki.mow.api.Page page) Get the number of attachment of the given page
org.exoplatform.wiki.mow.api.Wiki	getOrCreateUserWiki(String username) Gets a user Wiki.
org.exoplatform.wiki.mow.api.Page	getPageById(String id) Gets a wiki page based on its unique id.
org.exoplatform.wiki.mow.api.Page	getPageByRootPermission(String wikiType, String wikiOwner, String pageId) Gets a wiki page regardless of the current user's permission.
List<org.exoplatform.wiki.service.listener.PageWikiListener>	getPageListeners() Gets listeners of all wiki pages that are registered into the Wiki service.
org.exoplatform.wiki.mow.api.Page	getPageOfWikiByName(String wikiType, String wikiOwner, String pageName) Gets a wiki page by its unique name in the wiki.
String	getPageRenderedContent(org.exoplatform.wiki.mow.api.Page page, String targetSyntax) Get renderd content of a page
org.exoplatform.wiki.mow.api.Page	getParentPageOf(org.exoplatform.wiki.mow.api.Page page) Get parent page of a wiki page
List<String>	getPreviousNamesOfPage(org.exoplatform.wiki.mow.api.Page page) Get previous names of a page
org.exoplatform.wiki.mow.api.Page	getRelatedPage(String wikiType, String wikiOwner, String pageId) Gets a related page of a wiki page which is specified by a given Id.
List<org.exoplatform.wiki.mow.api.Page>	getRelatedPagesOfPage(org.exoplatform.wiki.mow.api.Page page) Gets a list of related pages based on a given param.
long	getSaveDraftSequenceTime() Gets an interval which specifies the periodical auto-saving for pages in Wiki.
String	getSpaceNameByGroupId(String groupId) Gets a space name by a given group Id.
org.exoplatform.wiki.mow.api.Template	getTemplatePage(org.exoplatform.wiki.service.WikiPageParams params, String templateId) Gets a Wiki template.
Map<String,org.exoplatform.wiki.mow.api.Template>	getTemplates(org.exoplatform.wiki.service.WikiPageParams params) Gets a map of wiki templates based on a given params object.
org.exoplatform.wiki.mow.api.PageVersion	getVersionOfPageByName(String versionName, org.exoplatform.wiki.mow.api.Page page) Gets a specific version by name of the given page
List<org.exoplatform.wiki.mow.api.PageVersion>	getVersionsOfPage(org.exoplatform.wiki.mow.api.Page page) Gets all the versions of the given page
List<String>	getWatchersOfPage(org.exoplatform.wiki.mow.api.Page page) Get all the watchers of a page
org.exoplatform.wiki.mow.api.Wiki	getWikiById(String wikiId) Gets a Wiki by its Id.
org.exoplatform.wiki.mow.api.Wiki	getWikiByTypeAndOwner(String wikiType, String owner) Gets a Wiki which is defined by its type and owner.
List<org.exoplatform.wiki.mow.api.PermissionEntry>	getWikiDefaultPermissions(String wikiType, String wikiOwner) Gets a list of Wiki default permissions.
String	getWikiNameById(String wikiId) Gets a Wiki name by its Id.
org.exoplatform.wiki.service.WikiPageParams	getWikiPageParams(org.exoplatform.wiki.service.BreadcrumbData data) Gets parameters of a wiki page based on the data stored in the breadcrumb.
List<org.exoplatform.wiki.mow.api.PermissionEntry>	getWikiPermission(String wikiType, String wikiOwner) Gets a list of Wiki permissions based on its type and owner.
List<org.exoplatform.wiki.mow.api.Wiki>	getWikisByType(String wikiType) Gets all wikis of the given type
String	getWikiWebappUri() Gets a Wiki webapp URI.
boolean	hasAdminPagePermission(String wikiType, String owner) Checks if the current user has the admin permission on a wiki page.
boolean	hasAdminSpacePermission(String wikiType, String owner) Checks if the current user has the admin permission on a space or not.
boolean	hasPermissionOnPage(org.exoplatform.wiki.mow.api.Page page, org.exoplatform.wiki.mow.api.PermissionType permissionType, Identity user) Checks if the given user has the permission on a page
boolean	isDraftOutDated(org.exoplatform.wiki.mow.api.DraftPage draftPage) Check if a draft page is outdated
boolean	isExisting(String wikiType, String wikiOwner, String pageId) Checks if a wiki page exists or not.
boolean	isHiddenSpace(String groupId) Checks if a space is hidden or not.
boolean	isSpaceMember(String spaceId, String userId) Checks if a given user is member of space or not.
boolean	movePage(org.exoplatform.wiki.service.WikiPageParams currentLocationParams, org.exoplatform.wiki.service.WikiPageParams newLocationParams) Move a wiki Page
void	removeDraft(String draftName) Removes a draft page by its name.
void	removeDraftOfPage(org.exoplatform.wiki.service.WikiPageParams param) Removes a draft page of a wiki page which is specified by the wiki page param.
void	removeRelatedPage(org.exoplatform.wiki.service.WikiPageParams orginaryPageParams, org.exoplatform.wiki.service.WikiPageParams relatedPageParams) Removes a related page of the current wiki page.
boolean	renamePage(String wikiType, String wikiOwner, String pageName, String newName, String newTitle) Renames a wiki page.
void	restoreVersionOfPage(String versionName, org.exoplatform.wiki.mow.api.Page page) Restores a version of a page
org.exoplatform.commons.utils.PageList<org.exoplatform.wiki.service.search.SearchResult>	search(org.exoplatform.wiki.service.search.WikiSearchData data) Searches in all wiki pages.
List<org.exoplatform.wiki.service.impl.SpaceBean>	searchSpaces(String keyword) Searches for spaces by a given keyword.
List<org.exoplatform.wiki.service.search.TemplateSearchResult>	searchTemplate(org.exoplatform.wiki.service.search.TemplateSearchData data) Searches in all templates.
void	updatePage(org.exoplatform.wiki.mow.api.Page page, org.exoplatform.wiki.service.PageUpdateType type) Update the given page.
void	updateTemplate(org.exoplatform.wiki.mow.api.Template template) Modifies an existing wiki template.
void	updateWikiPermission(String wikiType, String wikiOwner, List<org.exoplatform.wiki.mow.api.PermissionEntry> permissionEntries) Adds a list of permissions to Wiki.

Method Detail

createPage

org.exoplatform.wiki.mow.api.Page createPage(org.exoplatform.wiki.mow.api.Wiki wiki,
                                           String parentPageName,
                                           org.exoplatform.wiki.mow.api.Page page)
                                             throws org.exoplatform.wiki.WikiException

Create a new wiki page in the given wiki, under the given parent page.

Parameters:

wiki - It can be Portal, Group, or User.

parentPageName - Name of the parent wiki page.

Returns:

The new wiki page.

Throws:

org.exoplatform.wiki.WikiException

createTemplatePage

void createTemplatePage(org.exoplatform.wiki.mow.api.Wiki wiki,
                      org.exoplatform.wiki.mow.api.Template template)
                        throws org.exoplatform.wiki.WikiException

Creates a new Wiki template.

Parameters:

wiki - Wiki of the template

template - The params object which is used for creating the new Wiki template.

Throws:

org.exoplatform.wiki.WikiException

deletePage

boolean deletePage(String wikiType,
                 String wikiOwner,
                 String pageId)
                   throws org.exoplatform.wiki.WikiException

Deletes a wiki page.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

"True" if deleting the wiki page is successful, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

deleteTemplatePage

void deleteTemplatePage(String wikiType,
                      String wikiOwner,
                      String templateName)
                        throws org.exoplatform.wiki.WikiException

Deletes a Wiki template.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

templateName - Name of the Wiki template.

Throws:

org.exoplatform.wiki.WikiException

renamePage

boolean renamePage(String wikiType,
                 String wikiOwner,
                 String pageName,
                 String newName,
                 String newTitle)
                   throws org.exoplatform.wiki.WikiException

Renames a wiki page.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageName - Old name of the wiki page.

newName - New name of the wiki page.

newTitle - New title of the wiki page.

Returns:

"True" if renaming the wiki page is successful, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

movePage

boolean movePage(org.exoplatform.wiki.service.WikiPageParams currentLocationParams,
               org.exoplatform.wiki.service.WikiPageParams newLocationParams)
                 throws org.exoplatform.wiki.WikiException

Move a wiki Page

Parameters:

currentLocationParams - The current location of the wiki page.

newLocationParams - The new location of the wiki page.

Returns:

"True" if moving the wiki page is successful, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

getWikiPermission

List<org.exoplatform.wiki.mow.api.PermissionEntry> getWikiPermission(String wikiType,
                                                                   String wikiOwner)
                                                                     throws org.exoplatform.wiki.WikiException

Gets a list of Wiki permissions based on its type and owner.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

Returns:

The list of Wiki permissions.

Throws:

org.exoplatform.wiki.WikiException

updateWikiPermission

void updateWikiPermission(String wikiType,
                        String wikiOwner,
                        List<org.exoplatform.wiki.mow.api.PermissionEntry> permissionEntries)
                          throws org.exoplatform.wiki.WikiException

Adds a list of permissions to Wiki.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

permissionEntries - The list of permissions.

Throws:

org.exoplatform.wiki.WikiException

getPageOfWikiByName

org.exoplatform.wiki.mow.api.Page getPageOfWikiByName(String wikiType,
                                                    String wikiOwner,
                                                    String pageName)
                                                      throws org.exoplatform.wiki.WikiException

Gets a wiki page by its unique name in the wiki.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageName - Id of the wiki page.

Returns:

The wiki page if the current user has the read permission. Otherwise, it is "null".

Throws:

org.exoplatform.wiki.WikiException

getPageByRootPermission

org.exoplatform.wiki.mow.api.Page getPageByRootPermission(String wikiType,
                                                        String wikiOwner,
                                                        String pageId)
                                                          throws org.exoplatform.wiki.WikiException

Gets a wiki page regardless of the current user's permission.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The wiki page.

Throws:

org.exoplatform.wiki.WikiException

getRelatedPage

org.exoplatform.wiki.mow.api.Page getRelatedPage(String wikiType,
                                               String wikiOwner,
                                               String pageId)
                                                 throws org.exoplatform.wiki.WikiException

Gets a related page of a wiki page which is specified by a given Id.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The related wiki page.

Throws:

org.exoplatform.wiki.WikiException

getExsitedOrNewDraftPageById

org.exoplatform.wiki.mow.api.Page getExsitedOrNewDraftPageById(String wikiType,
                                                             String wikiOwner,
                                                             String pageId)
                                                               throws org.exoplatform.wiki.WikiException

Gets a wiki page or its draft if existing by its Id.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The wiki page or its draft.

Throws:

org.exoplatform.wiki.WikiException

getPageById

org.exoplatform.wiki.mow.api.Page getPageById(String id)
                                              throws org.exoplatform.wiki.WikiException

Gets a wiki page based on its unique id.

Parameters:

id - Unique id of the wiki page.

Returns:

The wiki page.

Throws:

org.exoplatform.wiki.WikiException

getPageRenderedContent

String getPageRenderedContent(org.exoplatform.wiki.mow.api.Page page,
                            String targetSyntax)

Get renderd content of a page

Parameters:

page - The wiki page

targetSyntax - The syntax

Returns:

The rendered content

addPageLink

void addPageLink(org.exoplatform.wiki.service.WikiPageParams param,
               org.exoplatform.wiki.service.WikiPageParams entity)

Add a link between 2 pages

Parameters:

param - First page

entity - Second page

getParentPageOf

org.exoplatform.wiki.mow.api.Page getParentPageOf(org.exoplatform.wiki.mow.api.Page page)
                                                  throws org.exoplatform.wiki.WikiException

Get parent page of a wiki page

Parameters:

page - Wiki page.

Returns:

The list of children pages

Throws:

org.exoplatform.wiki.WikiException

getChildrenPageOf

List<org.exoplatform.wiki.mow.api.Page> getChildrenPageOf(org.exoplatform.wiki.mow.api.Page page)
                                                          throws org.exoplatform.wiki.WikiException

Get all the children pages of a wiki page

Parameters:

page - Wiki page.

Returns:

The list of children pages

Throws:

org.exoplatform.wiki.WikiException

getTemplatePage

org.exoplatform.wiki.mow.api.Template getTemplatePage(org.exoplatform.wiki.service.WikiPageParams params,
                                                    String templateId)
                                                      throws org.exoplatform.wiki.WikiException

Gets a Wiki template.

Parameters:

params - The params object which is used for creating the Wiki template.

templateId - Id of the wiki template.

Returns:

The wiki template.

Throws:

org.exoplatform.wiki.WikiException

getBreadcumb

List<org.exoplatform.wiki.service.BreadcrumbData> getBreadcumb(String wikiType,
                                                             String wikiOwner,
                                                             String pageId)
                                                               throws org.exoplatform.wiki.WikiException

Gets a list of data which is used for composing the breadcrumb.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page to which the breadcrumb points.

Returns:

The list of data.

Throws:

org.exoplatform.wiki.WikiException

getWikiPageParams

org.exoplatform.wiki.service.WikiPageParams getWikiPageParams(org.exoplatform.wiki.service.BreadcrumbData data)
                                                              throws org.exoplatform.wiki.WikiException

Gets parameters of a wiki page based on the data stored in the breadcrumb.

Parameters:

data - The data in the breadcrumb that identifies the wiki page.

Returns:

The parameters identifying the wiki page.

Throws:

org.exoplatform.wiki.WikiException

search

org.exoplatform.commons.utils.PageList<org.exoplatform.wiki.service.search.SearchResult> search(org.exoplatform.wiki.service.search.WikiSearchData data)
                                                                                                throws org.exoplatform.wiki.WikiException

Searches in all wiki pages.

Parameters:

data - The data to search.

Returns:

Search results.

Throws:

org.exoplatform.wiki.WikiException

searchTemplate

List<org.exoplatform.wiki.service.search.TemplateSearchResult> searchTemplate(org.exoplatform.wiki.service.search.TemplateSearchData data)
                                                                              throws org.exoplatform.wiki.WikiException

Searches in all templates.

Parameters:

data - The data to search.

Returns:

Search results.

Throws:

org.exoplatform.wiki.WikiException

getDuplicatePages

List<org.exoplatform.wiki.mow.api.Page> getDuplicatePages(org.exoplatform.wiki.mow.api.Page parentPage,
                                                        org.exoplatform.wiki.mow.api.Wiki targetWiki,
                                                        List<org.exoplatform.wiki.mow.api.Page> resultList)
                                                          throws org.exoplatform.wiki.WikiException

Checks if a page and its children are duplicated with ones in the target Wiki or not, then gets a list of duplicated pages if any.

Parameters:

parentPage - The page to check.

targetWiki - The target Wiki to check.

resultList - The list of duplicated wiki pages.

Returns:

The list of duplicated wiki pages.

Throws:

org.exoplatform.wiki.WikiException

getDefaultWikiSyntaxId

String getDefaultWikiSyntaxId()

Gets Id of a default Wiki syntax.

Returns:

The Id.

getSaveDraftSequenceTime

long getSaveDraftSequenceTime()

Gets an interval which specifies the periodical auto-saving for pages in Wiki.

Returns:

The interval. Its default value is 30 seconds.

getEditPageLivingTime

long getEditPageLivingTime()

Get the living time of edited page

Returns:

The living time of edited page

getAttachmentsOfPage

List<org.exoplatform.wiki.mow.api.Attachment> getAttachmentsOfPage(org.exoplatform.wiki.mow.api.Page page)
                                                                   throws org.exoplatform.wiki.WikiException

Gets attachments of the given page

Parameters:

page - The wiki page

Returns:

The attachments of the page

Throws:

org.exoplatform.wiki.WikiException

getNbOfAttachmentsOfPage

int getNbOfAttachmentsOfPage(org.exoplatform.wiki.mow.api.Page page)
                             throws org.exoplatform.wiki.WikiException

Get the number of attachment of the given page

Parameters:

page - The wiki page

Returns:

The number of attachments of the page

Throws:

org.exoplatform.wiki.WikiException

getAttachmentOfPageByName

org.exoplatform.wiki.mow.api.Attachment getAttachmentOfPageByName(String attachmentName,
                                                                org.exoplatform.wiki.mow.api.Page page)
                                                                  throws org.exoplatform.wiki.WikiException

Get a attachment of a ther given page by name

Parameters:

attachmentName - The name of the attachment

page - The wiki page

Returns:

Throws:

org.exoplatform.wiki.WikiException

addAttachmentToPage

void addAttachmentToPage(org.exoplatform.wiki.mow.api.Attachment attachment,
                       org.exoplatform.wiki.mow.api.Page page)
                         throws org.exoplatform.wiki.WikiException

Add the given attachment to the given page

Parameters:

attachment - The attachment to add

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

deleteAttachmentOfPage

void deleteAttachmentOfPage(String attachmentId,
                          org.exoplatform.wiki.mow.api.Page page)
                            throws org.exoplatform.wiki.WikiException

Deletes the given attachment of the given page

Parameters:

attachmentId - Id of the attachment

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

getHelpSyntaxPage

org.exoplatform.wiki.mow.api.Page getHelpSyntaxPage(String syntaxId,
                                                  boolean fullContent)
                                                    throws org.exoplatform.wiki.WikiException

Gets a Help wiki page based on a given syntax Id.

Parameters:

syntaxId - Id of the syntax.

fullContent - true to get the full help page content, false to get an excerpt

Returns:

The Help wiki page.

Throws:

org.exoplatform.wiki.WikiException

getTemplates

Map<String,org.exoplatform.wiki.mow.api.Template> getTemplates(org.exoplatform.wiki.service.WikiPageParams params)
                                                               throws org.exoplatform.wiki.WikiException

Gets a map of wiki templates based on a given params object.

Parameters:

params - The params object which is used for getting the wiki templates.

Returns:

The map of wiki templates.

Throws:

org.exoplatform.wiki.WikiException

updateTemplate

void updateTemplate(org.exoplatform.wiki.mow.api.Template template)
                    throws org.exoplatform.wiki.WikiException

Modifies an existing wiki template.

Parameters:

template - The updated wiki template.

Throws:

org.exoplatform.wiki.WikiException

isExisting

boolean isExisting(String wikiType,
                 String wikiOwner,
                 String pageId)
                   throws org.exoplatform.wiki.WikiException

Checks if a wiki page exists or not.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

pageId - Id of the wiki page.

Returns:

The returned value is "true" if the page exists, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

getWikiDefaultPermissions

List<org.exoplatform.wiki.mow.api.PermissionEntry> getWikiDefaultPermissions(String wikiType,
                                                                           String wikiOwner)
                                                                             throws org.exoplatform.wiki.WikiException

Gets a list of Wiki default permissions.

Parameters:

wikiType - It can be Portal, Group, or User.

wikiOwner - The Wiki owner.

Returns:

The list of Wiki default permissions.

Throws:

org.exoplatform.wiki.WikiException

addComponentPlugin

void addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Registers a component plugin into the Wiki service.

Parameters:

plugin - The component plugin to be registered.

addWikiTemplatePagePlugin

void addWikiTemplatePagePlugin(org.exoplatform.wiki.plugin.WikiTemplatePagePlugin templatePlugin)

Adds a Wiki template as plugin.

Parameters:

templatePlugin - The wiki template plugin to be added.

addEmotionIconsPlugin

void addEmotionIconsPlugin(org.exoplatform.wiki.plugin.WikiEmotionIconsPlugin plugin)

Adds a Wiki emotion icons as plugin.

Parameters:

plugin - The wiki emotion icons plugin to be added.

getPageListeners

List<org.exoplatform.wiki.service.listener.PageWikiListener> getPageListeners()

Gets listeners of all wiki pages that are registered into the Wiki service.

Returns:

The list of listeners.

getAttachmentListeners

List<org.exoplatform.wiki.service.listener.AttachmentWikiListener> getAttachmentListeners()

Gets attachment listeners that are registered into the Wiki service.

Returns:

The list of attachment listeners.

addRelatedPage

void addRelatedPage(org.exoplatform.wiki.service.WikiPageParams orginaryPageParams,
                  org.exoplatform.wiki.service.WikiPageParams relatedPageParams)
                    throws org.exoplatform.wiki.WikiException

Adds a related page to the current wiki page.

Parameters:

orginaryPageParams - The params object of the current wiki page.

relatedPageParams - The params object of the related page.

Throws:

org.exoplatform.wiki.WikiException

getRelatedPagesOfPage

List<org.exoplatform.wiki.mow.api.Page> getRelatedPagesOfPage(org.exoplatform.wiki.mow.api.Page page)
                                                              throws org.exoplatform.wiki.WikiException

Gets a list of related pages based on a given param.

Parameters:

page - The wiki page.

Returns:

The list of related pages.

Throws:

org.exoplatform.wiki.WikiException

removeRelatedPage

void removeRelatedPage(org.exoplatform.wiki.service.WikiPageParams orginaryPageParams,
                     org.exoplatform.wiki.service.WikiPageParams relatedPageParams)
                       throws org.exoplatform.wiki.WikiException

Removes a related page of the current wiki page.

Parameters:

orginaryPageParams - The params object of the current wiki page.

relatedPageParams - The params object of the related page.

Throws:

org.exoplatform.wiki.WikiException

createDraftForExistPage

org.exoplatform.wiki.mow.api.DraftPage createDraftForExistPage(org.exoplatform.wiki.mow.api.DraftPage draftPage,
                                                             org.exoplatform.wiki.mow.api.Page targetPage,
                                                             String revision,
                                                             long clientTime)
                                                               throws org.exoplatform.wiki.WikiException

Creates a draft page for a wiki page which is specified by a given param object.

Parameters:

targetPage - The target wiki page.

revision - The revision which is used for creating the draft page. If "null", this will be the last revision.

clientTime - The time of client when the draft page is saved.

Returns:

The draft page.

Throws:

org.exoplatform.wiki.WikiException - if the draft page cannot be created.

createDraftForNewPage

org.exoplatform.wiki.mow.api.DraftPage createDraftForNewPage(org.exoplatform.wiki.mow.api.DraftPage draftPage,
                                                           org.exoplatform.wiki.mow.api.Page parentPage,
                                                           long clientTime)
                                                             throws org.exoplatform.wiki.WikiException

Creates a draft page for a new wiki page whose parent is specified by a given param object.

Parameters:

parentPage - The parent wiki page.

clientTime - The time of client when the draft page is saved.

Returns:

The draft page.

Throws:

org.exoplatform.wiki.WikiException - if the draft page cannot be created.

getDraftOfPage

org.exoplatform.wiki.mow.api.DraftPage getDraftOfPage(org.exoplatform.wiki.mow.api.Page page)
                                                      throws org.exoplatform.wiki.WikiException

Gets a draft page of a wiki page which is specified by a given param object.

Parameters:

page - The wiki page.

Returns:

The draft page, or "null" if the draft page does not exist.

Throws:

org.exoplatform.wiki.WikiException

getDraft

org.exoplatform.wiki.mow.api.DraftPage getDraft(String draftName)
                                                throws org.exoplatform.wiki.WikiException

Gets a draft page by its name.

Parameters:

draftName - Name of the draft page.

Returns:

The draft page, or "null" if it does not exist.

Throws:

org.exoplatform.wiki.WikiException

removeDraftOfPage

void removeDraftOfPage(org.exoplatform.wiki.service.WikiPageParams param)
                       throws org.exoplatform.wiki.WikiException

Removes a draft page of a wiki page which is specified by the wiki page param.

Parameters:

param - The param object of the wiki page param.

Throws:

org.exoplatform.wiki.WikiException

removeDraft

void removeDraft(String draftName)
                 throws org.exoplatform.wiki.WikiException

Removes a draft page by its name.

Parameters:

draftName - Name of the draft page.

Throws:

org.exoplatform.wiki.WikiException

getDraftsOfUser

List<org.exoplatform.wiki.mow.api.DraftPage> getDraftsOfUser(String username)
                                                             throws org.exoplatform.wiki.WikiException

Gets a list of draft pages belonging to a given user.

Parameters:

username - Name of the user.

Returns:

The list of draft pages.

Throws:

org.exoplatform.wiki.WikiException

isDraftOutDated

boolean isDraftOutDated(org.exoplatform.wiki.mow.api.DraftPage draftPage)
                        throws org.exoplatform.wiki.WikiException

Check if a draft page is outdated

Parameters:

draftPage -

Returns:

Throws:

org.exoplatform.wiki.WikiException

getLastestDraft

org.exoplatform.wiki.mow.api.DraftPage getLastestDraft()
                                                       throws org.exoplatform.wiki.WikiException

Gets the last created draft of a wiki page.

Returns:

The last draft.

Throws:

org.exoplatform.wiki.WikiException

getDraftChanges

org.exoplatform.wiki.service.diff.DiffResult getDraftChanges(org.exoplatform.wiki.mow.api.DraftPage draftPage)
                                                             throws org.exoplatform.wiki.WikiException

Gets the changes between the draft page and the target page

Returns:

Throws:

org.exoplatform.wiki.WikiException

getOrCreateUserWiki

org.exoplatform.wiki.mow.api.Wiki getOrCreateUserWiki(String username)
                                                      throws org.exoplatform.wiki.WikiException

Gets a user Wiki. If it does not exist, the new one will be created.

Parameters:

username - Name of the user.

Returns:

The user Wiki.

Throws:

org.exoplatform.wiki.WikiException

getSpaceNameByGroupId

String getSpaceNameByGroupId(String groupId)

Gets a space name by a given group Id.

Parameters:

groupId - The group Id.

Returns:

The space name.

Throws:

org.exoplatform.wiki.WikiException

searchSpaces

List<org.exoplatform.wiki.service.impl.SpaceBean> searchSpaces(String keyword)
                                                               throws org.exoplatform.wiki.WikiException

Searches for spaces by a given keyword.

Parameters:

keyword - The keyword to search for spaces.

Returns:

The list of spaces matching with the keyword.

Throws:

org.exoplatform.wiki.WikiException

getWikiByTypeAndOwner

org.exoplatform.wiki.mow.api.Wiki getWikiByTypeAndOwner(String wikiType,
                                                      String owner)
                                                        throws org.exoplatform.wiki.WikiException

Gets a Wiki which is defined by its type and owner.

Parameters:

wikiType - It can be Portal, Group, or User.

owner - The Wiki owner.

Returns:

The Wiki.

Throws:

org.exoplatform.wiki.WikiException

getWikisByType

List<org.exoplatform.wiki.mow.api.Wiki> getWikisByType(String wikiType)
                                                       throws org.exoplatform.wiki.WikiException

Gets all wikis of the given type

Parameters:

wikiType - Type of wiki

Returns:

Wikis of the given type

Throws:

org.exoplatform.wiki.WikiException

createWiki

org.exoplatform.wiki.mow.api.Wiki createWiki(String wikiType,
                                           String owner)
                                             throws org.exoplatform.wiki.WikiException

Creates a wiki with the given type and owner

Parameters:

wikiType - It can be Portal, Group, or User.

owner - The Wiki owner.

Throws:

org.exoplatform.wiki.WikiException

getWikiWebappUri

String getWikiWebappUri()

Gets a Wiki webapp URI.

Returns:

The Wiki webapp URI.

isSpaceMember

boolean isSpaceMember(String spaceId,
                    String userId)

Checks if a given user is member of space or not.

Parameters:

spaceId - Id of the space.

userId - The username.

Returns:

"True" if the user is member, or "false" if not.

isHiddenSpace

boolean isHiddenSpace(String groupId)

Checks if a space is hidden or not.

Parameters:

groupId - Id of the group.

Returns:

The returned value is "true" if the space is hidden, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

hasPermissionOnPage

boolean hasPermissionOnPage(org.exoplatform.wiki.mow.api.Page page,
                          org.exoplatform.wiki.mow.api.PermissionType permissionType,
                          Identity user)
                            throws org.exoplatform.wiki.WikiException

Checks if the given user has the permission on a page

Parameters:

user -

page -

permissionType -

Returns:

Throws:

org.exoplatform.wiki.WikiException

hasAdminSpacePermission

boolean hasAdminSpacePermission(String wikiType,
                              String owner)
                                throws org.exoplatform.wiki.WikiException

Checks if the current user has the admin permission on a space or not.

Parameters:

wikiType - It can be Portal, Group, or User.

owner - Owner of the space.

Returns:

The returned value is "true" if the current user has the admin permission on the space, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

hasAdminPagePermission

boolean hasAdminPagePermission(String wikiType,
                             String owner)
                               throws org.exoplatform.wiki.WikiException

Checks if the current user has the admin permission on a wiki page.

Parameters:

wikiType - It can be Portal, Group, or User.

owner - Owner of the wiki page.

Returns:

"True" if the current user has the admin permission on the wiki page, or "false" if not.

Throws:

org.exoplatform.wiki.WikiException

getWikiById

org.exoplatform.wiki.mow.api.Wiki getWikiById(String wikiId)
                                              throws org.exoplatform.wiki.WikiException

Gets a Wiki by its Id.

Parameters:

wikiId - The Wiki Id.

Returns:

The Wiki.

Throws:

org.exoplatform.wiki.WikiException

getWikiNameById

String getWikiNameById(String wikiId)
                       throws org.exoplatform.wiki.WikiException

Gets a Wiki name by its Id.

Parameters:

wikiId - The Wiki Id.

Returns:

The Wiki name.

Throws:

org.exoplatform.wiki.WikiException

canModifyPagePermission

boolean canModifyPagePermission(org.exoplatform.wiki.mow.api.Page currentPage,
                              String currentUser)
                                throws org.exoplatform.wiki.WikiException

Check if the given user can update the page

Parameters:

currentPage - The page to update

currentUser - The user that needs to update the page

Returns:

true if the user can update the page

Throws:

org.exoplatform.wiki.WikiException

canPublicAndRetrictPage

boolean canPublicAndRetrictPage(org.exoplatform.wiki.mow.api.Page currentPage,
                              String currentUser)
                                throws org.exoplatform.wiki.WikiException

Check if the given user can public or restrict the page

Parameters:

currentPage -

currentUser -

Returns:

true if the current user has EditPage permission or admin page or admin space

Throws:

org.exoplatform.wiki.WikiException

getVersionsOfPage

List<org.exoplatform.wiki.mow.api.PageVersion> getVersionsOfPage(org.exoplatform.wiki.mow.api.Page page)
                                                                 throws org.exoplatform.wiki.WikiException

Gets all the versions of the given page

Parameters:

page - The wiki page

Returns:

All the versions of the page

Throws:

org.exoplatform.wiki.WikiException

getVersionOfPageByName

org.exoplatform.wiki.mow.api.PageVersion getVersionOfPageByName(String versionName,
                                                              org.exoplatform.wiki.mow.api.Page page)
                                                                throws org.exoplatform.wiki.WikiException

Gets a specific version by name of the given page

Parameters:

versionName - The name of the version

page - The wiki page

Returns:

The version of the wiki page

Throws:

org.exoplatform.wiki.WikiException

createVersionOfPage

void createVersionOfPage(org.exoplatform.wiki.mow.api.Page page)
                         throws org.exoplatform.wiki.WikiException

Creates a version of a page. This method only tag the current page data as a new version, it does not update the page data

Parameters:

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

restoreVersionOfPage

void restoreVersionOfPage(String versionName,
                        org.exoplatform.wiki.mow.api.Page page)
                          throws org.exoplatform.wiki.WikiException

Restores a version of a page

Parameters:

versionName - The name of the version to restore

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

updatePage

void updatePage(org.exoplatform.wiki.mow.api.Page page,
              org.exoplatform.wiki.service.PageUpdateType type)
                throws org.exoplatform.wiki.WikiException

Update the given page. This does not automatically create a new version. If a new version must be created it should be explicitly done by calling createVersionOfPage(). The second parameter is the type of update done (title only, content only, both, move, ...).

Parameters:

page - Updated page

type - Type of update

Throws:

org.exoplatform.wiki.WikiException

getPreviousNamesOfPage

List<String> getPreviousNamesOfPage(org.exoplatform.wiki.mow.api.Page page)
                                    throws org.exoplatform.wiki.WikiException

Get previous names of a page

Parameters:

page - The wiki page

Returns:

List of all the previous names of the page

Throws:

org.exoplatform.wiki.WikiException

createEmotionIcon

void createEmotionIcon(org.exoplatform.wiki.mow.api.EmotionIcon emotionIcon)
                       throws org.exoplatform.wiki.WikiException

Creates a emotion icon

Parameters:

emotionIcon - The emotion icon to add

Throws:

org.exoplatform.wiki.WikiException

getEmotionIcons

List<org.exoplatform.wiki.mow.api.EmotionIcon> getEmotionIcons()
                                                               throws org.exoplatform.wiki.WikiException

Gets all the emotion icons

Returns:

All the emotion icons

Throws:

org.exoplatform.wiki.WikiException

getEmotionIconByName

org.exoplatform.wiki.mow.api.EmotionIcon getEmotionIconByName(String name)
                                                              throws org.exoplatform.wiki.WikiException

Gets an emotion icon by name

Parameters:

name - The name of the emotion icon

Returns:

The emotion icon

Throws:

org.exoplatform.wiki.WikiException

getWatchersOfPage

List<String> getWatchersOfPage(org.exoplatform.wiki.mow.api.Page page)
                               throws org.exoplatform.wiki.WikiException

Get all the watchers of a page

Parameters:

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

addWatcherToPage

void addWatcherToPage(String username,
                    org.exoplatform.wiki.mow.api.Page page)
                      throws org.exoplatform.wiki.WikiException

Add the given user as watcher of the wiki page

Parameters:

username - Username of the user to add as watcher

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException

deleteWatcherOfPage

void deleteWatcherOfPage(String username,
                       org.exoplatform.wiki.mow.api.Page page)
                         throws org.exoplatform.wiki.WikiException

Delete a user as watcher of the given page

Parameters:

username - Username of the user to delete as watcher

page - The wiki page

Throws:

org.exoplatform.wiki.WikiException