com.sap.netweaver.coll.wiki.api

Interface IWikiPage

All Superinterfaces:

IWikiObject

public interface IWikiPage
extends IWikiObject

Wiki Page

Nested Class Summary

static class

IWikiPage.State States of page

Method Summary

IWikiPage	cancel() Cancels editing of page
void	edit() Opens page for editing.
String	getAlias() Return alias of page.
List<String>	getApprovers() Returns list of approvers of page
Iterable<IWikiAttachment>	getAttachments() Returns attachments to page.
Iterable<IWikiComment>	getAuthorComments() Returns author comments of page
List<String>	getAuthors() Returns list of authors contributed to the page.
String	getBody() Returns body of page
String	getChangesSummary() Returns summary of the last change.
Iterable<IWikiComment>	getComments() Returns comments of page
Date	getCreationDate() Returns creation date of page.
Date	getExpirationDate() Expiration date of the page
Date	getModificationDate() Returns modification date of page
Map<String,String>	getProperties() Returns extended properties of page
List<String>	getReviewers() Returns list of reviewers of page.
IWikiSpace	getSpace() Returns the space to which the page is attached
IWikiPage.State	getState() Returns state of page
String	getSubject() Return subject of page
String	getSummary() Returns summary of page.
Set<String>	getTags() Returns tags of page
String	getUnfilteredBody() Returns unfiltered body of page.
String	getUnfilteredSubject() Returns unfiltered subject of page.
int	getVersionNumber() Returns version number of page.
Iterable<IWikiPageVersion>	getVersions() Returns all versions of the page
int	getViewCount() Returns page view count
void	publish() Publishes page.
void	refresh() Retrieves latest content/properties of page.
IWikiPage	save() Saves wiki page.
void	setAlias(String alias) Sets alias of page
void	setBody(String body) Sets body of page
void	setChangesSummary(String changesSummary) Sets changes summary of page
void	setSubject(String subject) Sets subject of page
void	setSummary(String summary) Sets summary of page
boolean	wasAliasUpdated() Checks if alias was updated
boolean	wasBodyUpdated() Checks if body was updated
boolean	wasChangesSummaryUpdated() Checks if summary of changes was updated
boolean	wasSubjectUpdated() Checks if subject was updated
boolean	wasSummaryUpdated() Checks if summary was updated

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

getID

Method Detail

getVersionNumber

int getVersionNumber()

Returns version number of page.

Returns:

version number

getCreationDate

Date getCreationDate()

Returns creation date of page.

Returns:

creation date.

getModificationDate

Date getModificationDate()

Returns modification date of page

Returns:

modification date

getSubject

String getSubject()

Return subject of page

Returns:

subject

getUnfilteredSubject

String getUnfilteredSubject()

Returns unfiltered subject of page.

Returns:

unfiltered subject

getBody

String getBody()

Returns body of page

Returns:

body

getUnfilteredBody

String getUnfilteredBody()

Returns unfiltered body of page.

Returns:

unfiltered body

getSummary

String getSummary()

Returns summary of page.

Returns:

summary

getChangesSummary

String getChangesSummary()

Returns summary of the last change.

Returns:

summary of change.

getAuthors

List<String> getAuthors()

Returns list of authors contributed to the page.

Returns:

list of authors

getExpirationDate

Date getExpirationDate()

Expiration date of the page

Returns:

expiration date

getReviewers

List<String> getReviewers()

Returns list of reviewers of page.

Returns:

list of reviewers

getApprovers

List<String> getApprovers()

Returns list of approvers of page

Returns:

list of approvers

getAlias

String getAlias()

Return alias of page.

Returns:

alias

getViewCount

int getViewCount()

Returns page view count

Returns:

view count

getState

IWikiPage.State getState()

Returns state of page

Returns:

state of page

See Also:

IWikiPage.State

getTags

Set<String> getTags()

Returns tags of page

Returns:

tags of page

edit

void edit()
          throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                 com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyEditedException

Opens page for editing.

Throws:

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

com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyEditedException

publish

void publish()
             throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException

Publishes page.

Throws:

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

cancel

IWikiPage cancel()
                 throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                        com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyExistException

Cancels editing of page

Returns:

true if successfull.

Throws:

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

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

refresh

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

Retrieves latest content/properties of page.

Throws:

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

getSpace

IWikiSpace getSpace()

Returns the space to which the page is attached

Returns:

space

getVersions

Iterable<IWikiPageVersion> getVersions()

Returns all versions of the page

Returns:

all versions of the page

getAttachments

Iterable<IWikiAttachment> getAttachments()

Returns attachments to page.

Returns:

iterable of attachments

getComments

Iterable<IWikiComment> getComments()

Returns comments of page

Returns:

iterable of comments

getAuthorComments

Iterable<IWikiComment> getAuthorComments()

Returns author comments of page

Returns:

iterable of author comments

getProperties

Map<String,String> getProperties()

Returns extended properties of page

Returns:

extended properties

setAlias

void setAlias(String alias)

Sets alias of page

Parameters:

alias - the alias

setBody

void setBody(String body)

Sets body of page

Parameters:

body - the body

setChangesSummary

void setChangesSummary(String changesSummary)

Sets changes summary of page

Parameters:

changesSummary - the summary of changes

setSubject

void setSubject(String subject)

Sets subject of page

Parameters:

subject - the subject

setSummary

void setSummary(String summary)

Sets summary of page

Parameters:

summary - the summary

wasAliasUpdated

boolean wasAliasUpdated()

Checks if alias was updated

Returns:

true if alias was updated

wasBodyUpdated

boolean wasBodyUpdated()

Checks if body was updated

Returns:

true if body was updated

wasChangesSummaryUpdated

boolean wasChangesSummaryUpdated()

Checks if summary of changes was updated

Returns:

true if summary of changes was updated

wasSubjectUpdated

boolean wasSubjectUpdated()

Checks if subject was updated

Returns:

true if subject was updated

wasSummaryUpdated

boolean wasSummaryUpdated()

Checks if summary was updated

Returns:

true if summary was updated

save

IWikiPage save()
               throws com.sap.netweaver.coll.wiki.exception.WikiPageNotFoundException,
                      com.sap.netweaver.coll.wiki.exception.WikiPageAlreadyExistException

Saves wiki page.

Returns:

wiki page.

Throws:

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

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

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