Package org.xwiki.platform.wiki.creationjob

Class WikiCreationRequest

java.lang.Object
org.xwiki.job.AbstractRequest
org.xwiki.platform.wiki.creationjob.WikiCreationRequest
All Implemented Interfaces:
Serializable, org.xwiki.job.Request
public class WikiCreationRequest extends org.xwiki.job.AbstractRequest
A wiki creation request containing all information about a wiki to create.
Since:
7.0M2
Version:
$Id: aaed44f70989e6b6c6bf4b0d1c3ae59cbfda6c9f $
See Also:

  • Constructor Details

    • WikiCreationRequest

      public WikiCreationRequest()
      Default constructor.

    • WikiCreationRequest

      public WikiCreationRequest(org.xwiki.job.Request request)
      Parameters:
      request - the request to copy

  • Method Details

    • getWikiId

      public String getWikiId()
      Returns:
      id of the wiki to create

    • setWikiId

      public void setWikiId(String wikiId)
      Parameters:
      wikiId - id of the wiki to create

    • getPrettyName

      public String getPrettyName()
      Returns:
      pretty name of the wiki to create

    • setPrettyName

      public void setPrettyName(String prettyName)
      Parameters:
      prettyName - pretty name of the wiki to create

    • getAlias

      public String getAlias()
      Returns:
      default alias of the wiki to create

    • setAlias

      public void setAlias(String alias)
      Parameters:
      alias - default alias of the wiki to create

    • getDescription

      public String getDescription()
      Returns:
      the description field of the wiki to create

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description field of the wiki to create

    • isTemplate

      public boolean isTemplate()
      Returns:
      if the wiki to create will be a template or no

    • setTemplate

      public void setTemplate(boolean isTemplate)
      Parameters:
      isTemplate - if the wiki to create will be a template or no

    • getTemplateId

      public String getTemplateId()
      Returns:
      id of the template used to fill the wiki to create

    • setTemplateId

      public void setTemplateId(String templateId)
      Set the id of the template of the wiki to create. Do not forget to use setWikiSource() too.
      Parameters:
      templateId - id of the template used to fill the wiki to create

    • getExtensionId

      public org.xwiki.extension.ExtensionId getExtensionId()
      Returns:
      id of the main extension of the wiki to create

    • setExtensionId

      public void setExtensionId(org.xwiki.extension.ExtensionId extensionId)
      Set the id of the main extension of the wiki to create. Do not forget to use setWikiSource() too.
      Parameters:
      extensionId - id of the main extension of the wiki to create

    • setExtensionId

      public void setExtensionId(String extensionId, String version)
      Set the id of the main extension of the wiki to create. Do not forget to use setWikiSource() too.
      Parameters:
      extensionId - id of the main extension of the wiki to create
      version - version of the extension

    • getOwnerId

      public String getOwnerId()
      Returns:
      id of the owner of the wiki to create

    • setOwnerId

      public void setOwnerId(String ownerId)
      Parameters:
      ownerId - id of the owner of the wiki to create

    • getUserScope

      public UserScope getUserScope()
      Returns:
      the user scope of the wiki to create

    • setUserScope

      public void setUserScope(UserScope userScope)
      Parameters:
      userScope - the user scope of the wiki to create

    • getMembershipType

      public MembershipType getMembershipType()
      Returns:
      the membership type of the wiki to create

    • setMembershipType

      public void setMembershipType(MembershipType membershipType)
      Parameters:
      membershipType - the membership type of the wiki to create

    • getMembers

      public List<String> getMembers()
      Returns:
      the list of the members to add in the wiki to create

    • setMembers

      public void setMembers(List<String> members)
      Parameters:
      members - the list of the members to add in the wiki to create

    • isFailOnExist

      public boolean isFailOnExist()
      Returns:
      whether or not the wiki creation should fail if the database already exists

    • setFailOnExist

      public void setFailOnExist(boolean failOnExist)
      Parameters:
      failOnExist - whether or not the wiki creation should fail if the database already exists

    • getWikiSource

      public WikiSource getWikiSource()
      Returns:
      source of the wiki to create

    • setWikiSource

      public void setWikiSource(WikiSource wikiSource)
      Parameters:
      wikiSource - source of the wiki to create