com.sap.netweaver.coll.wiki.api

Interface IWikiPageManager

public interface IWikiPageManager

Entry point for managing pages in wiki application.

Method Summary

IWikiPage	createPage(IWikiSpace space, String subject, String body) Creates page
boolean	deletePage(IWikiPage page) Deletes wiki page.
boolean	deletePage(long pageID) Deletes a page by unique identifier
boolean	deletePageVersion(IWikiPageVersion version) Deletes page version
boolean	deletePageVersion(long pageID, int versionNumber) Deletes page version by page and version number.
IWikiPage	getPage(long pageID) Returns specific page.
Iterable<IWikiPage>	getPages(long spaceID) Returns page in community.
IWikiPageVersion	getPageVersion(long pageID, int versionID) Returns version of page

Method Detail

getPage

IWikiPage getPage(long pageID)
                  throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Returns specific page.

Parameters:

pageID - unique identifier of page

Returns:

the specific page

Throws:

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

getPages

Iterable<IWikiPage> getPages(long spaceID)
                             throws com.sap.netweaver.coll.wiki.exception.WikiSpaceNotFoundException

Returns page in community.

Parameters:

spaceID - unique identifier of community

Returns:

iterable of pages

Throws:

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

createPage

IWikiPage createPage(IWikiSpace space,
                     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 page

Parameters:

space - space to which pages is to be attached

subject - subject of the page

body - body of the page

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)

Deletes wiki page.

Parameters:

page - the page

Returns:

true if page is delete

deletePage

boolean deletePage(long pageID)

Deletes a page by unique identifier

Parameters:

pageID - unique identifier of page

Returns:

true if page was deleted

deletePageVersion

boolean deletePageVersion(IWikiPageVersion version)
                          throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Deletes page version

Parameters:

version - the version to be deleted

Returns:

true if page version is deleted

Throws:

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

deletePageVersion

boolean deletePageVersion(long pageID,
                          int versionNumber)
                          throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Deletes page version by page and version number.

Parameters:

pageID - unique identifier of page

versionNumber - the version number to be deleted

Returns:

true if page version is deleted

Throws:

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

getPageVersion

IWikiPageVersion getPageVersion(long pageID,
                                int versionID)
                                throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                                       com.sap.netweaver.coll.wiki.exception.WikiObjectNotFoundException

Returns version of page

Parameters:

pageID - page unique identifier

versionID - version unique identifier

Returns:

page version

Throws:

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

com.sap.netweaver.coll.wiki.exception.WikiObjectNotFoundException

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