com.sap.netweaver.coll.wiki.api

Interface IWikiSpace

All Superinterfaces:

IWikiObject

public interface IWikiSpace
extends IWikiObject

Wiki space, also know as wiki community of just community.

Method Summary

IWikiPage	createPage(String subject, String body) Creates a page
IWikiSpace	createSpace(String name, String description) Creates a sub space
IWikiSpace	createSpace(String name, String description, String url) Creates s sub space
boolean	deletePage(IWikiPage page) Deletes page
Date	getCreationDate() Returns creation date of community.
String	getDescription() Returns description of community
String	getDisplayName() Returns display name of community
List<String>	getDocumentApprovers() Returns the list of document approvers for community
Locale	getLocale() Returns locale of community
Date	getModificationDate() Returns modification date of community
String	getName() Returns name of community
Iterable<IWikiPage>	getPages() Returns pages in community
IWikiSpace	getParentSpace() Return parent community or null if this community is the root community
Map<String,String>	getProperties() Returns extended properties of space
Iterable<IWikiSpace>	getSpaces() Returns child communities of community
Set<String>	getTags() Returns tags used in the community
int	getViewCount() Returns total view count of pages in community
void	refresh() Retrieves latest properties / content of community
void	setDescription(String description) Sets description of community
void	setDisplayName(String displayName) Sets display name of community
void	setLocale(Locale locale) Sets locale of community
void	setName(String name) Sets name community

Methods inherited from interface com.sap.netweaver.coll.wiki.api.IWikiObject

getID

Method Detail

getName

String getName()

Returns name of community

Returns:

name of community

setName

void setName(String name)

Sets name community

Parameters:

name - the name

getDisplayName

String getDisplayName()

Returns display name of community

Returns:

display name

setDisplayName

void setDisplayName(String displayName)
                    throws com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

Sets display name of community

Parameters:

displayName - the display name

Throws:

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

getDescription

String getDescription()

Returns description of community

Returns:

description

setDescription

void setDescription(String description)

Sets description of community

Parameters:

description - the description

getCreationDate

Date getCreationDate()

Returns creation date of community.

Returns:

creation date

getDocumentApprovers

List<String> getDocumentApprovers()

Returns the list of document approvers for community

Returns:

list of approvers by username

getModificationDate

Date getModificationDate()

Returns modification date of community

Returns:

modification date

getViewCount

int getViewCount()

Returns total view count of pages in community

Returns:

total view count

getLocale

Locale getLocale()

Returns locale of community

Returns:

locale

setLocale

void setLocale(Locale locale)

Sets locale of community

Parameters:

locale - the locale

getTags

Set<String> getTags()

Returns tags used in the community

Returns:

set of tags

getSpaces

Iterable<IWikiSpace> getSpaces()

Returns child communities of community

Returns:

iterable of child communities

refresh

void refresh()
             throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

Retrieves latest properties / content of community

Throws:

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

getPages

Iterable<IWikiPage> getPages()

Returns pages in community

Returns:

iterable of pages

getParentSpace

IWikiSpace getParentSpace()

Return parent community or null if this community is the root community

Returns:

parent community

createSpace

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

Creates a sub space

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 s sub space

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

createPage

IWikiPage createPage(String subject,
                     String body)
                     throws com.sap.netweaver.coll.wiki.exception.UserNotFoundException,
                            com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyExistException,
                            com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException,
                            com.sap.netweaver.coll.wiki.exception.NameAlreadyExistsException

Creates a page

Parameters:

subject - the subject

body - the body

Returns:

created page

Throws:

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

com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyExistException

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

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

deletePage

boolean deletePage(IWikiPage page)
                   throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                          com.sap.netweaver.coll.wiki.exception.InvalidWikiContextException

Deletes page

Parameters:

page - the page

Returns:

true if page is deleted

Throws:

com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

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

getProperties

Map<String,String> getProperties()

Returns extended properties of space

Returns:

extended properties

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