Package org.exoplatform.wiki.service

Interface DataStorage

All Known Implementing Classes:

JPADataStorage

public interface DataStorage

Method Summary

Modifier and Type	Method	Description
void	addAttachmentToPage(Attachment attachment, Page page)
PageVersion	addPageVersion(Page page, String userName)	Creates a new page version
void	addRelatedPage(Page page, Page relatedPage)
void	addWatcherToPage(String username, Page page)
DraftPage	createDraftPageForUser(DraftPage draftPage, String username)	Creates a new draft note
Page	createPage(Wiki wiki, Page parentPage, Page page)
Wiki	createWiki(Wiki wiki)
void	deleteAttachmentOfPage(String attachmentId, Page page)
void	deleteAttachmentsOfDraftPage(DraftPage draftPage)	Delete attachments of target draft page
void	deleteDraftById(String id)	Deletes a draft note by its technical id.
void	deleteDraftByName(String newDraftPageName)
void	deleteDraftOfPage(Page page)
void	deleteDraftOfPage(Page page, String lang)
void	deleteOrphanDraftPagesByParentPage(long parentPageId)	Remove all children drafts of a parent page without existing target
void	deletePage(String wikiType, String wikiOwner, String pageId)
void	deleteVersionsByNoteIdAndLang(Long noteId, String lang)	Deletes a list of versions of note by language.
void	deleteWatcherOfPage(String username, Page page)
List<Attachment>	getAttachmentsOfPage(Page page)
default List<Attachment>	getAttachmentsOfPage(Page page, boolean loadContent)
List<Page>	getChildrenPageOf(Page page, boolean withDrafts, boolean withChild)	Get children notes and draft notes of page
DraftPage	getDraft(WikiPageParams param)
DraftPage	getDraftOfPageByLang(Page page, String lang)
DraftPage	getDraftPageById(String id)
List<DraftPage>	getDraftsOfPage(Long pageId)
List<DraftPage>	getDraftsOfWiki(String wikiOwner, String wikiType)	Gets draft pages of a given wiki
Page	getExsitedOrNewDraftPageById(String wikiType, String wikiOwner, String pageId, String username)
Page	getHelpSyntaxPage(String syntaxId, boolean fullContent, List<org.exoplatform.container.xml.ValuesParam> syntaxHelpParams, org.exoplatform.container.configuration.ConfigurationManager configurationManager)
List<PageHistory>	getHistoryOfPage(Page page)
DraftPage	getLatestDraftOfPage(Page targetPage)	Returns latest draft of given page.
DraftPage	getLatestDraftPageByTargetPageAndLang(Long targetPageId, String lang)	Retrieves latest draft of a specific page by target page id and content language
List<String>	getPageAvailableTranslationLanguages(Long pageId)	Retrieves list of available translations languages of a page
Page	getPageById(String id)	Get a wiki page by its unique id
List<PageHistory>	getPageHistoryVersionsByPageIdAndLang(Long pageId, String lang)	Retrieves list of page versions by page id and lang
Page	getPageOfWikiByName(String wikiType, String wikiOwner, String pageName)	Get a wiki page by its unique name in the wiki
List<Page>	getPagesOfWiki(String wikiType, String wikiOwner)	Retrieve the all pages contained in wiki
PageVersion	getPageVersionById(long versionId)	Gets page version by its given id
Page	getParentPageOf(Page page)
List<String>	getPreviousNamesOfPage(Page page)
PageVersion	getPublishedVersionByPageIdAndLang(Long pageId, String lang)	Retrieves the published note page version by its id and content language
Page	getRelatedPage(String wikiType, String wikiOwner, String pageId)
List<Page>	getRelatedPagesOfPage(Page page)
List<PageVersion>	getVersionsOfPage(Page page)
List<String>	getWatchersOfPage(Page page)
Wiki	getWikiByTypeAndOwner(String wikiType, String owner)
List<PermissionEntry>	getWikiPermission(String wikiType, String wikiOwner)
List<Wiki>	getWikisByType(String wikiType)
boolean	hasAdminPagePermission(String wikiType, String owner, org.exoplatform.services.security.Identity user)
boolean	hasAdminSpacePermission(String wikiType, String owner, org.exoplatform.services.security.Identity user)
boolean	hasChildren(long noteId)	Check if the given note page has children or not
boolean	hasDrafts(long noteId)	Check if the given note page has drafts or not
boolean	hasPermissionOnPage(Page page, PermissionType permissionType, org.exoplatform.services.security.Identity user)	Check if the identity has the given permission type on a page
boolean	hasPermissionOnWiki(Wiki wiki, PermissionType permissionType, org.exoplatform.services.security.Identity identity)	Check if the identity has the given permission type on a wiki
void	movePage(WikiPageParams currentLocationParams, WikiPageParams newLocationParams)
void	removeRelatedPage(Page page, Page relatedPage)
void	renamePage(String wikiType, String wikiOwner, String pageName, String newName, String newTitle)
PageVersion	restoreVersionOfPage(String versionName, Page page)	Restore a note from given version
org.exoplatform.commons.utils.PageList<SearchResult>	search(WikiSearchData data)
List<TemplateSearchResult>	searchTemplate(TemplateSearchData data)
DraftPage	updateDraftPageForUser(DraftPage draftPage, String username)	Updates a draft note
Page	updatePage(Page page)
void	updateWikiPermission(String wikiType, String wikiOwner, List<PermissionEntry> permissionEntries)

Method Details

getWikiByTypeAndOwner

Wiki getWikiByTypeAndOwner(String wikiType,
 String owner)
                    throws WikiException

Throws:

WikiException

getWikisByType

List<Wiki> getWikisByType(String wikiType)
                   throws WikiException

Throws:

WikiException

createWiki

Wiki createWiki(Wiki wiki)
         throws WikiException

Throws:

WikiException

createPage

Page createPage(Wiki wiki,
 Page parentPage,
 Page page)
         throws WikiException

Throws:

WikiException

getPageOfWikiByName

Page getPageOfWikiByName(String wikiType,
 String wikiOwner,
 String pageName)
                  throws WikiException

Get a wiki page by its unique name in the wiki

Parameters:

wikiType - The wiki type

wikiOwner - The wiki owner

pageName - The unique name of the page in the wiki

Returns:

The wiki page

Throws:

WikiException - if an error occured

getPageById

Page getPageById(String id)
          throws WikiException

Get a wiki page by its unique id

Parameters:

id - The unique id of wiki page

Returns:

The wiki page

Throws:

WikiException - if an error occured

getDraftPageById

DraftPage getDraftPageById(String id)
                    throws WikiException

Throws:

WikiException

getDraftOfPageByLang

DraftPage getDraftOfPageByLang(Page page,
 String lang)
                        throws WikiException

Throws:

WikiException

getParentPageOf

Page getParentPageOf(Page page)
              throws WikiException

Throws:

WikiException

getChildrenPageOf

List<Page> getChildrenPageOf(Page page,
 boolean withDrafts,
 boolean withChild)
                      throws WikiException

Get children notes and draft notes of page

Parameters:

page - the target page to retrieve its children

withDrafts - if set to true returns the children notes and draft notes,

withChild - Check if note has child

Returns:

children notes of page

Throws:

WikiException

hasChildren

boolean hasChildren(long noteId)

Check if the given note page has children or not

Parameters:

noteId - note page id

Returns:

true if the given note page has children and false if not

hasDrafts

boolean hasDrafts(long noteId)

Check if the given note page has drafts or not

Parameters:

noteId - note page id

Returns:

true if the given note page has drafts and false if not

deletePage

void deletePage(String wikiType,
 String wikiOwner,
 String pageId)
         throws WikiException

Throws:

WikiException

deleteDraftOfPage

void deleteDraftOfPage(Page page)
                throws WikiException

Throws:

WikiException

deleteDraftOfPage

void deleteDraftOfPage(Page page,
 String lang)
                throws WikiException

Throws:

WikiException

deleteDraftById

void deleteDraftById(String id)
              throws WikiException

Deletes a draft note by its technical id.

Parameters:

id - Id of the draft note.

Throws:

WikiException - if an error occured

deleteDraftByName

void deleteDraftByName(String newDraftPageName)
                throws WikiException

Throws:

WikiException

renamePage

void renamePage(String wikiType,
 String wikiOwner,
 String pageName,
 String newName,
 String newTitle)
         throws WikiException

Throws:

WikiException

movePage

void movePage(WikiPageParams currentLocationParams,
 WikiPageParams newLocationParams)
       throws WikiException

Throws:

WikiException

getWikiPermission

List<PermissionEntry> getWikiPermission(String wikiType,
 String wikiOwner)
                                 throws WikiException

Throws:

WikiException

updateWikiPermission

void updateWikiPermission(String wikiType,
 String wikiOwner,
 List<PermissionEntry> permissionEntries)
                   throws WikiException

Throws:

WikiException

getRelatedPagesOfPage

List<Page> getRelatedPagesOfPage(Page page)
                          throws WikiException

Throws:

WikiException

getRelatedPage

Page getRelatedPage(String wikiType,
 String wikiOwner,
 String pageId)
             throws WikiException

Throws:

WikiException

addRelatedPage

void addRelatedPage(Page page,
 Page relatedPage)
             throws WikiException

Throws:

WikiException

removeRelatedPage

void removeRelatedPage(Page page,
 Page relatedPage)
                throws WikiException

Throws:

WikiException

getExsitedOrNewDraftPageById

Page getExsitedOrNewDraftPageById(String wikiType,
 String wikiOwner,
 String pageId,
 String username)
                           throws WikiException

Throws:

WikiException

getDraftsOfPage

List<DraftPage> getDraftsOfPage(Long pageId)
                         throws WikiException

Throws:

WikiException

getDraft

DraftPage getDraft(WikiPageParams param)
            throws WikiException

Throws:

WikiException

getLatestDraftOfPage

DraftPage getLatestDraftOfPage(Page targetPage)
                        throws WikiException

Returns latest draft of given page.

Parameters:

targetPage -

Returns:

latest draft of the given target page

Throws:

WikiException

createDraftPageForUser

DraftPage createDraftPageForUser(DraftPage draftPage,
 String username)
                          throws WikiException

Creates a new draft note

Parameters:

draftPage - The draft note to be created

username - Author name

Returns:

Created draft note

Throws:

WikiException

updateDraftPageForUser

DraftPage updateDraftPageForUser(DraftPage draftPage,
 String username)
                          throws WikiException

Updates a draft note

Parameters:

draftPage - The draft note to be updated

username -

Returns:

Updated draft note

Throws:

WikiException

search

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

Throws:

WikiException

searchTemplate

List<TemplateSearchResult> searchTemplate(TemplateSearchData data)
                                   throws WikiException

Throws:

WikiException

getAttachmentsOfPage

default List<Attachment> getAttachmentsOfPage(Page page,
 boolean loadContent)
                                       throws WikiException

Throws:

WikiException

getAttachmentsOfPage

List<Attachment> getAttachmentsOfPage(Page page)
                               throws WikiException

Throws:

WikiException

addAttachmentToPage

void addAttachmentToPage(Attachment attachment,
 Page page)
                  throws WikiException

Throws:

WikiException

deleteAttachmentOfPage

void deleteAttachmentOfPage(String attachmentId,
 Page page)
                     throws WikiException

Throws:

WikiException

getHelpSyntaxPage

Page getHelpSyntaxPage(String syntaxId,
 boolean fullContent,
 List<org.exoplatform.container.xml.ValuesParam> syntaxHelpParams,
 org.exoplatform.container.configuration.ConfigurationManager configurationManager)
                throws WikiException

Throws:

WikiException

hasPermissionOnPage

boolean hasPermissionOnPage(Page page,
 PermissionType permissionType,
 org.exoplatform.services.security.Identity user)
                     throws WikiException

Check if the identity has the given permission type on a page

Parameters:

page - Page

permissionType - Permission type to check

user - Identity of the user

Returns:

true if the user has the given permission type on the page

Throws:

WikiException - if an error occured

hasPermissionOnWiki

boolean hasPermissionOnWiki(Wiki wiki,
 PermissionType permissionType,
 org.exoplatform.services.security.Identity identity)
                     throws WikiException

Check if the identity has the given permission type on a wiki

Parameters:

wiki - Wiki

permissionType - Permission type to check

identity - Identity of the user

Returns:

true if the user has the given permission type on the wiki

Throws:

WikiException - if an error occured

hasAdminSpacePermission

boolean hasAdminSpacePermission(String wikiType,
 String owner,
 org.exoplatform.services.security.Identity user)
                         throws WikiException

Throws:

WikiException

hasAdminPagePermission

boolean hasAdminPagePermission(String wikiType,
 String owner,
 org.exoplatform.services.security.Identity user)
                        throws WikiException

Throws:

WikiException

getVersionsOfPage

List<PageVersion> getVersionsOfPage(Page page)
                             throws WikiException

Throws:

WikiException

getHistoryOfPage

List<PageHistory> getHistoryOfPage(Page page)
                            throws WikiException

Throws:

WikiException

addPageVersion

PageVersion addPageVersion(Page page,
 String userName)
                    throws WikiException

Creates a new page version

Parameters:

page - target note page

userName - current username

Returns:

PageVersion

Throws:

WikiException

restoreVersionOfPage

PageVersion restoreVersionOfPage(String versionName,
 Page page)
                          throws WikiException

Restore a note from given version

Parameters:

versionName - version name

page - target note page

Returns:

PageVersion

Throws:

WikiException

updatePage

Page updatePage(Page page)
         throws WikiException

Throws:

WikiException

getPreviousNamesOfPage

List<String> getPreviousNamesOfPage(Page page)
                             throws WikiException

Throws:

WikiException

getWatchersOfPage

List<String> getWatchersOfPage(Page page)
                        throws WikiException

Throws:

WikiException

addWatcherToPage

void addWatcherToPage(String username,
 Page page)
               throws WikiException

Throws:

WikiException

deleteWatcherOfPage

void deleteWatcherOfPage(String username,
 Page page)
                  throws WikiException

Throws:

WikiException

getPagesOfWiki

List<Page> getPagesOfWiki(String wikiType,
 String wikiOwner)

Retrieve the all pages contained in wiki

Parameters:

wikiType - the wiki type

wikiOwner - the wiki owner

Returns:

the List pf pages of the wiki

deleteAttachmentsOfDraftPage

void deleteAttachmentsOfDraftPage(DraftPage draftPage)

Delete attachments of target draft page

Parameters:

draftPage - target draft page

getPageHistoryVersionsByPageIdAndLang

List<PageHistory> getPageHistoryVersionsByPageIdAndLang(Long pageId,
 String lang)

Retrieves list of page versions by page id and lang

Parameters:

pageId - page id

lang - content language

Returns:

List of PageHistory

getLatestDraftPageByTargetPageAndLang

DraftPage getLatestDraftPageByTargetPageAndLang(Long targetPageId,
 String lang)

Retrieves latest draft of a specific page by target page id and content language

Parameters:

targetPageId - target page id

lang - content language

Returns:

DraftPage

getPublishedVersionByPageIdAndLang

PageVersion getPublishedVersionByPageIdAndLang(Long pageId,
 String lang)

Retrieves the published note page version by its id and content language

Parameters:

pageId - page id

lang - content language

Returns:

PageVersion

getPageAvailableTranslationLanguages

List<String> getPageAvailableTranslationLanguages(Long pageId)

Retrieves list of available translations languages of a page

Parameters:

pageId - page id

Returns:

List of String

deleteVersionsByNoteIdAndLang

void deleteVersionsByNoteIdAndLang(Long noteId,
 String lang)
                            throws WikiException

Deletes a list of versions of note by language.

Parameters:

noteId - Id of the note.

lang - language.

Throws:

WikiException - if an error occured

deleteOrphanDraftPagesByParentPage

void deleteOrphanDraftPagesByParentPage(long parentPageId)

Remove all children drafts of a parent page without existing target

Parameters:

parentPageId - Note parent page id

getPageVersionById

PageVersion getPageVersionById(long versionId)

Gets page version by its given id

Parameters:

versionId - page version id

Returns:

PageVersion

getDraftsOfWiki

List<DraftPage> getDraftsOfWiki(String wikiOwner,
 String wikiType)

Gets draft pages of a given wiki

Parameters:

wikiOwner - wiki owner

wikiType - wiki type

Returns:

List of DraftPage