Class WikiCreationJobScriptServices
- java.lang.Object
-
- org.xwiki.platform.wiki.creationjob.script.WikiCreationJobScriptServices
-
- All Implemented Interfaces:
org.xwiki.script.service.ScriptService
@Component @Singleton @Named("wiki.creationjob") public class WikiCreationJobScriptServices extends Object implements org.xwiki.script.service.ScriptService
Script services for the creation of wikis.- Since:
- 7.0M2
- Version:
- $Id: cff08628458824ccf4b2c5e7882c2f78b748dc2d $
-
-
Constructor Summary
Constructors Constructor Description WikiCreationJobScriptServices()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.xwiki.job.Job
createWiki(WikiCreationRequest request)
Asynchronously create a wiki.org.xwiki.extension.ExtensionId
getDefaultWikiExtensionId()
org.xwiki.job.event.status.JobStatus
getJobStatus(String wikiId)
Exception
getLastError()
Get the error generated while performing the previously called action.WikiCreationRequest
newWikiCreationRequest()
-
-
-
Method Detail
-
createWiki
public org.xwiki.job.Job createWiki(WikiCreationRequest request)
Asynchronously create a wiki.- Parameters:
request
- creation wiki request containing all information about the wiki to create- Returns:
- the creationjob that creates the wiki
-
getDefaultWikiExtensionId
public org.xwiki.extension.ExtensionId getDefaultWikiExtensionId()
- Returns:
- the extension id of the default flavor
-
getJobStatus
public org.xwiki.job.event.status.JobStatus getJobStatus(String wikiId)
- Parameters:
wikiId
- id of the wiki- Returns:
- the creationjob status corresponding to the creation of the wiki
-
newWikiCreationRequest
public WikiCreationRequest newWikiCreationRequest()
- Returns:
- a new request for the creation of a new wiki
-
getLastError
public Exception getLastError()
Get the error generated while performing the previously called action.- Returns:
- an eventual exception or
null
if no exception was thrown - Since:
- 1.1
-
-