A C D E G H I O P R S W

A

addAlias(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

addPropertyGroup(WikiPropertyGroup) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

Add a property group to the wiki.

C

copy(String, String, String, boolean, boolean, boolean) - Method in interface org.xwiki.wiki.manager.WikiManager

Copy a wiki.

create(String, String, boolean) - Method in interface org.xwiki.wiki.manager.WikiManager

Create a new wiki.

createAndExecuteJob(String, String, Object) - Method in interface org.xwiki.wiki.provisioning.WikiProvisioningJobExecutor

Create a job and execute it.

D

delete(String) - Method in interface org.xwiki.wiki.manager.WikiManager

Delete a wiki.

E

equals(Object) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

equals(Object) - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

exists(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

Check if a wiki corresponding to an Id exists.

G

get(String) - Method in class org.xwiki.wiki.properties.WikiPropertyGroup

Get the value of a property.

get(String) - Method in interface org.xwiki.wiki.properties.WikiPropertyGroupProvider

Get the WikiDescriptor Property Group corresponding to a wiki.

getAliases() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getAll() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

Get the list of all wikis (except the main one).

getByAlias(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

Get a wiki from one of its alias.

getById(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

Get a wiki from its Id.

getCurrentWikiId() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

getDefaultAlias() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

The default alias is the alias used to generate URL for that wiki.

getDescription() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getId() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getId() - Method in class org.xwiki.wiki.properties.WikiPropertyGroup

getJob(List<String>) - Method in interface org.xwiki.wiki.provisioning.WikiProvisioningJobExecutor

Get a wiki provisioning job.

getMainPageReference() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getMainWikiDescriptor() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

getMainWikiId() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

getOwnerId() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getPrettyName() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getPropertyGroup(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getProvisioningJobParameter() - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

getReference() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

getWikiId() - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

H

hashCode() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

hashCode() - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

I

idAvailable(String) - Method in interface org.xwiki.wiki.manager.WikiManager

Check if the wikiId is valid and available (the name is not already taken for technical reasons).

isHidden() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

O

org.xwiki.wiki.descriptor - package org.xwiki.wiki.descriptor

org.xwiki.wiki.manager - package org.xwiki.wiki.manager

org.xwiki.wiki.properties - package org.xwiki.wiki.properties

org.xwiki.wiki.provisioning - package org.xwiki.wiki.provisioning

P

PROPERTY_PROVISIONING_JOB_PARAMETER - Static variable in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

Name of the property that stores the property used by the provisioning job.

PROPERTY_WIKI_ID - Static variable in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

Name of the property that stores the id of the wiki to provision.

R

rename(String, String) - Method in interface org.xwiki.wiki.manager.WikiManager

Rename a wiki.

S

save(WikiPropertyGroup, String) - Method in interface org.xwiki.wiki.properties.WikiPropertyGroupProvider

Save the WikiDescriptor Property Group corresponding to a wiki in the persistent storage.

saveDescriptor(WikiDescriptor) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager

Save the given descriptor and all its property groups.

set(String, Object) - Method in class org.xwiki.wiki.properties.WikiPropertyGroup

Set the value of a property.

setDefaultAlias(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

Set the default alias.

setDescription(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

setHidden(boolean) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

Set if the wiki is hidden.

setMainPageReference(DocumentReference) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

setOwnerId(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

setPrettyName(String) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor

setProvisioningJobParameter(Object) - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

setWikiId(String) - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

W

WikiDescriptor - Class in org.xwiki.wiki.descriptor

This class is a descriptor for wiki.

WikiDescriptor(String, String) - Constructor for class org.xwiki.wiki.descriptor.WikiDescriptor

Constructor.

WikiDescriptorManager - Interface in org.xwiki.wiki.descriptor

Component to list and get wiki descriptors.

WikiManager - Interface in org.xwiki.wiki.manager

Component to create and manage wikis.

WikiManagerException - Exception in org.xwiki.wiki.manager

Encapsulate any exception related to WikiDescriptor Manager.

WikiManagerException(String) - Constructor for exception org.xwiki.wiki.manager.WikiManagerException

Construct an exception with the specified detail message.

WikiManagerException(String, Throwable) - Constructor for exception org.xwiki.wiki.manager.WikiManagerException

Construct an exception with the specified detail message and cause.

WikiPropertyGroup - Class in org.xwiki.wiki.properties

Property group is a place where modules can store their own properties concerning a wiki.

WikiPropertyGroup(String) - Constructor for class org.xwiki.wiki.properties.WikiPropertyGroup

Constructor.

WikiPropertyGroupException - Exception in org.xwiki.wiki.properties

Encapsulate any exception related to WikiDescriptor Properties Groups.

WikiPropertyGroupException(String) - Constructor for exception org.xwiki.wiki.properties.WikiPropertyGroupException

Construct an exception with the specified detail message.

WikiPropertyGroupException(String, Throwable) - Constructor for exception org.xwiki.wiki.properties.WikiPropertyGroupException

Construct an exception with the specified detail message and cause.

WikiPropertyGroupProvider - Interface in org.xwiki.wiki.properties

Provider that manage WikiDescriptor Properties Groups.

WikiProvisioningJob - Interface in org.xwiki.wiki.provisioning

Component that provision wikis.

WikiProvisioningJobException - Exception in org.xwiki.wiki.provisioning

Encapsulate any exception related to Wiki Provisioning Jobs.

WikiProvisioningJobException(String) - Constructor for exception org.xwiki.wiki.provisioning.WikiProvisioningJobException

Construct an exception with the specified detail message.

WikiProvisioningJobException(String, Throwable) - Constructor for exception org.xwiki.wiki.provisioning.WikiProvisioningJobException

Construct an exception with the specified detail message and cause.

WikiProvisioningJobExecutor - Interface in org.xwiki.wiki.provisioning

Executor that manage jobs that provision wikis.

WikiProvisioningJobRequest - Class in org.xwiki.wiki.provisioning

Base class for Request implementations used by wiki provisioners.

WikiProvisioningJobRequest(List<String>, String, Object) - Constructor for class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

Constructor.

A C D E G H I O P R S W