@Role
public interface WikiManager
Modifier and Type | Method and Description |
---|---|
WikiDescriptor |
copy(String fromWikiId,
String newWikiId,
String newWikiAlias,
boolean copyHistory,
boolean copyRecycleBin,
boolean failOnExist)
Copy a wiki.
|
WikiDescriptor |
create(String wikiId,
String wikiAlias,
boolean failOnExist)
Create a new wiki.
|
default WikiDescriptor |
create(String wikiId,
String wikiAlias,
String ownerId,
boolean failOnExist)
Create a new wiki.
|
void |
delete(String wikiId)
Delete a wiki.
|
boolean |
idAvailable(String wikiId)
Check if the wikiId is valid and available (the name is not already taken for technical reasons).
|
WikiDescriptor |
rename(String wikiId,
String newWikiId)
Rename a wiki.
|
WikiDescriptor create(String wikiId, String wikiAlias, boolean failOnExist) throws WikiManagerException
wikiId
- Id of the new wikiwikiAlias
- Default alias of the new wikifailOnExist
- throw an exception if the wikiId already existsWikiManagerException
- if problems occurdefault WikiDescriptor create(String wikiId, String wikiAlias, String ownerId, boolean failOnExist) throws WikiManagerException
wikiId
- Id of the new wikiwikiAlias
- Default alias of the new wikiownerId
- the identifier of the owner of the wiki (generally a serialized user reference)failOnExist
- throw an exception if the wikiId already existsWikiManagerException
- if problems occurWikiDescriptor copy(String fromWikiId, String newWikiId, String newWikiAlias, boolean copyHistory, boolean copyRecycleBin, boolean failOnExist) throws WikiManagerException
fromWikiId
- If of the wiki to copynewWikiId
- Id of the new wikinewWikiAlias
- Default alias of the new wikicopyHistory
- decide if you want to copy the pages' historycopyRecycleBin
- decide if you want to copy the recycle bin contentfailOnExist
- throw an exception if the wikiId already existsWikiManagerException
- if problems occurWikiDescriptor rename(String wikiId, String newWikiId) throws WikiManagerException
wikiId
- If of the wiki to renamenewWikiId
- new Id of the wikiWikiManagerException
- if problems occurvoid delete(String wikiId) throws WikiManagerException
wikiId
- Id of the wiki to delete.WikiManagerException
- if problems occurboolean idAvailable(String wikiId) throws WikiManagerException
wikiId
- the Id to testWikiManagerException
- if problems occurCopyright © 2004–2021 XWiki. All rights reserved.