Package com.xwiki.macros.confluence

Class ConfluenceSpacesScriptService

java.lang.Object

com.xwiki.macros.confluence.ConfluenceSpacesScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Singleton
@Named("confluence.spaces")
@Unstable
public class ConfluenceSpacesScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Script Service to manipulate Migrated Confluence spaces.

Since:

1.19.0

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
ConfluenceSpacesScriptService()

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.EntityReference	getConfluenceSpace(com.xpn.xwiki.api.Document document)
org.xwiki.model.reference.EntityReference	getConfluenceSpace(String documentReference)
org.xwiki.model.reference.EntityReference	getConfluenceSpace(org.xwiki.model.reference.EntityReference documentReference)
org.xwiki.model.reference.EntityReference	getSloppySpace(String spaceKeyOrRef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfluenceSpacesScriptService

public ConfluenceSpacesScriptService()

Method Details

getConfluenceSpace

public org.xwiki.model.reference.EntityReference getConfluenceSpace(org.xwiki.model.reference.EntityReference documentReference)
                                                             throws org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException

Parameters:

documentReference - the document of which the root of the Confluence space should be returned

Returns:

the root of the Confluence space in which the given document is.

Throws:

org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException - if something wrong happens

getConfluenceSpace

public org.xwiki.model.reference.EntityReference getConfluenceSpace(String documentReference)
                                                             throws org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException

Parameters:

documentReference - the document of which the root of the Confluence space should be returned

Returns:

the root of the Confluence space in which the given document is.

Throws:

org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException - if something wrong happens

getConfluenceSpace

public org.xwiki.model.reference.EntityReference getConfluenceSpace(com.xpn.xwiki.api.Document document)
                                                             throws org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException

Parameters:

document - the document of which the root of the Confluence space should be returned

Returns:

the root of the Confluence space in which the given document is.

Throws:

org.xwiki.contrib.confluence.resolvers.ConfluenceResolverException - if something wrong happens

getSloppySpace

public org.xwiki.model.reference.EntityReference getSloppySpace(String spaceKeyOrRef)

Parameters:

spaceKeyOrRef - the space key, or "@self", or a XWiki reference to the space.

Returns:

the root of the Confluence space described by the parameter, or null if not found.