Skip navigation links
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

clone() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor
 
clone() - Method in class org.xwiki.wiki.properties.WikiPropertyGroup
 
copy(String, String, String, boolean, boolean, boolean) - Method in interface org.xwiki.wiki.manager.WikiManager
Copy a wiki.
copyDeletedDocuments(String, String) - Method in interface org.xwiki.wiki.provisioning.WikiCopier
Copy all deleted documents form a wiki to an other.
copyDocuments(String, String, boolean) - Method in interface org.xwiki.wiki.provisioning.WikiCopier
Copy all documents from a wiki to an other.
create(String, String, boolean) - Method in interface org.xwiki.wiki.manager.WikiManager
Create a new wiki.
create(String, 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
Deprecated.
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
Deprecated.
 
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
 
getAliasSuffix() - Method in interface org.xwiki.wiki.configuration.WikiConfiguration
 
getAll() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
Get the list of all wikis descriptors.
getAllIds() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
Get the list of all wikis identifiers.
getByAlias(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
Get a wiki from one of its aliases.
getById(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
Get a wiki from its Id.
getCurrentWikiDescriptor() - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
 
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
Deprecated.
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
 
getPort() - 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
Deprecated.
 
getProvisioningUser() - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
 
getReference() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor
 
getWikiId() - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
 

H

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

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
 
isMainWiki(String) - Method in interface org.xwiki.wiki.descriptor.WikiDescriptorManager
 
isSecure() - Method in class org.xwiki.wiki.descriptor.WikiDescriptor
 

O

org.xwiki.wiki.configuration - package org.xwiki.wiki.configuration
 
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
Deprecated.
Name of the property that stores the property used by the provisioning job.
PROPERTY_PROVISIONING_USER - Static variable in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
Name of the property that stores the user that is provisioning the wiki.
PROPERTY_WIKI_ID - Static variable in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
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
 
setPort(int) - 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
Deprecated.
 
setProvisioningUser(DocumentReference) - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
 
setSecure(Boolean) - Method in class org.xwiki.wiki.descriptor.WikiDescriptor
 
setWikiId(String) - Method in class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
 

W

WikiConfiguration - Interface in org.xwiki.wiki.configuration
Configuration options for the Wiki module.
WikiCopier - Interface in org.xwiki.wiki.provisioning
Copy all the documents from a wiki to an other.
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.
WikiDescriptor(String, 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
Deprecated.
since 7.0M2
WikiProvisioningJobException - Exception in org.xwiki.wiki.provisioning
Deprecated.
since 7.0M2
WikiProvisioningJobException(String) - Constructor for exception org.xwiki.wiki.provisioning.WikiProvisioningJobException
Deprecated.
Construct an exception with the specified detail message.
WikiProvisioningJobException(String, Throwable) - Constructor for exception org.xwiki.wiki.provisioning.WikiProvisioningJobException
Deprecated.
Construct an exception with the specified detail message and cause.
WikiProvisioningJobExecutor - Interface in org.xwiki.wiki.provisioning
Deprecated.
since 7.0M2
WikiProvisioningJobRequest - Class in org.xwiki.wiki.provisioning
Deprecated.
since 7.0M2
WikiProvisioningJobRequest(List<String>, String, Object) - Constructor for class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
WikiProvisioningJobRequest(List<String>, String, Object, DocumentReference) - Constructor for class org.xwiki.wiki.provisioning.WikiProvisioningJobRequest
Deprecated.
Constructor.
A C D E G H I O P R S W 
Skip navigation links

Copyright © 2004–2019 XWiki. All rights reserved.