com.sap.netweaver.coll.wiki.api

Interface IWikiSpaceManager

public interface IWikiSpaceManager

Entry point for managing spaces

Method Summary

IWikiSpace	createSpace(IWikiSpace parentSpace, String name, String description) Creates space in specific space
IWikiSpace	createSpace(IWikiSpace parentSpace, String name, String description, String url) Creates space in specific space
IWikiSpace	createSpace(String name, String description) Creates space inside the root space of the context
IWikiSpace	createSpace(String name, String description, String url) Creates space inside the root space of the context
boolean	deleteSpace(IWikiSpace space) Deletes space
IWikiSpace	getSpace(long spaceID) Returns space by unique identifier

Method Detail

getSpace

IWikiSpace getSpace(long spaceID)
                    throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

Returns space by unique identifier

Parameters:

spaceID - unique identifier of space

Returns:

space

Throws:

com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

createSpace

IWikiSpace createSpace(String name,
                       String description)
                       throws com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException,
                              com.sap.netweaver.coll.wiki.exception.UserNotFoundException

Creates space inside the root space of the context

Parameters:

name - the name

description - the description

Returns:

created space

Throws:

com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

createSpace

IWikiSpace createSpace(String name,
                       String description,
                       String url)
                       throws com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException,
                              com.sap.netweaver.coll.wiki.exception.UserNotFoundException

Creates space inside the root space of the context

Parameters:

name - the name

description - the description

url - the url

Returns:

created space

Throws:

com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

createSpace

IWikiSpace createSpace(IWikiSpace parentSpace,
                       String name,
                       String description)
                       throws com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException,
                              com.sap.netweaver.coll.wiki.exception.UserNotFoundException

Creates space in specific space

Parameters:

parentSpace - the parent space

name - the name

description - the description

Returns:

created space

Throws:

com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

createSpace

IWikiSpace createSpace(IWikiSpace parentSpace,
                       String name,
                       String description,
                       String url)
                       throws com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException,
                              com.sap.netweaver.coll.wiki.exception.UserNotFoundException

Creates space in specific space

Parameters:

parentSpace - the parent space

name - the name

description - the description

url - the url

Returns:

created space

Throws:

com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

com.sap.netweaver.coll.wiki.exception.UserNotFoundException

deleteSpace

boolean deleteSpace(IWikiSpace space)
                    throws com.sap.netweaver.coll.wiki.exception.InvalidWikiContextException

Deletes space

Parameters:

space - the space

Returns:

true if space is deleted

Throws:

com.sap.netweaver.coll.wiki.exception.InvalidWikiContextException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[com.sap] KMC-WIKI	[com.sap] com.sap.netweaver.coll.wiki.api	api	BC-COM-WIK