org.exoplatform.wiki.mow.api
Interface Page

All Known Subinterfaces:

DraftPage

All Known Implementing Classes:

DraftPageImpl, HelpPage, PageImpl, SimplePageImpl, Template, WikiHome

public interface Page

Version:

$Revision$

Method Summary

void	addPublicPage(Page page) Add a public wiki page
void	addWikiPage(Page page) Add a wiki page as child page
Collection<? extends Attachment>	getAttachments() Get the attachments of this page
String	getAuthor() The Author is changed when any part of the document changes (content, attachments).
String	getComment()
Attachment	getContent() Get the actual content of the page
Date	getCreatedDate() The date when creating page.
javax.jcr.Node	getJCRPageNode() Get JCR node of wiki page
String	getName() Get jcr node name
String	getOwner() Get the owner of the page
PageImpl	getParentPage() get the parent page
HashMap<String,String[]>	getPermission() Get map of permission of page
String	getSyntax() Get the syntax used in that page
String	getTitle()
Date	getUpdatedDate() The date when any part of the document changes (content, attachments).
String	getURL() get URL of page.
VersionableMixin	getVersionableMixin() get Versionable Mixin
Wiki	getWiki() get Wiki of page
boolean	hasPermission(PermissionType permissionType)
boolean	hasPermission(PermissionType permissionType, org.exoplatform.services.security.Identity user) Check if user has permisison on page or not
boolean	isMinorEdit() is page in minor edit or not
void	remove() Detroy wiki page
void	setComment(String comment)
void	setMinorEdit(boolean isMinorEdit) is page in minor edit or not
void	setName(String name) set jcr node name
void	setNonePermission() Reset page permisison
void	setPermission(HashMap<String,String[]> permissions) Set permission to page
void	setSyntax(String syntax)
void	setTitle(String title)
void	setURL(String url) set url

Method Detail

getName

String getName()

Get jcr node name

Returns:

jcr node name

setName

void setName(String name)

set jcr node name

Parameters:

name - Nodename

getOwner

String getOwner()

Get the owner of the page

Returns:

getAuthor

String getAuthor()

The Author is changed when any part of the document changes (content, attachments).

getCreatedDate

Date getCreatedDate()

The date when creating page.

getUpdatedDate

Date getUpdatedDate()

The date when any part of the document changes (content, attachments).

getContent

Attachment getContent()

Get the actual content of the page

Returns:

getSyntax

String getSyntax()

Get the syntax used in that page

Returns:

setSyntax

void setSyntax(String syntax)

getTitle

String getTitle()

setTitle

void setTitle(String title)

getComment

String getComment()

setComment

void setComment(String comment)

getAttachments

Collection<? extends Attachment> getAttachments()
                                                throws Exception

Get the attachments of this page

Returns:

Throws:

Exception

hasPermission

boolean hasPermission(PermissionType permissionType)
                      throws Exception

Throws:

Exception

hasPermission

boolean hasPermission(PermissionType permissionType,
                      org.exoplatform.services.security.Identity user)
                      throws Exception

Check if user has permisison on page or not

Parameters:

permissionType - The type of permisison to check PermissionType}

user - The user to check

Returns:

User has permisison on page or not

Throws:

Exception

getPermission

HashMap<String,String[]> getPermission()
                                       throws Exception

Get map of permission of page

Returns:

Throws:

Exception

setPermission

void setPermission(HashMap<String,String[]> permissions)
                   throws Exception

Set permission to page

Parameters:

permissions -

Throws:

Exception

getURL

String getURL()

get URL of page. The domain part of link can be fixed.

addWikiPage

void addWikiPage(Page page)

Add a wiki page as child page

Parameters:

page -

getJCRPageNode

javax.jcr.Node getJCRPageNode()
                              throws Exception

Get JCR node of wiki page

Returns:

JCR node of wiki page

Throws:

Exception

getVersionableMixin

VersionableMixin getVersionableMixin()

get Versionable Mixin

Returns:

Versionable Mixin

remove

void remove()

Detroy wiki page

getWiki

Wiki getWiki()

get Wiki of page

Returns:

Wiki of page

setMinorEdit

void setMinorEdit(boolean isMinorEdit)

is page in minor edit or not

Parameters:

isMinorEdit -

isMinorEdit

boolean isMinorEdit()

is page in minor edit or not

Returns:

setURL

void setURL(String url)

set url

Parameters:

url -

getParentPage

PageImpl getParentPage()

get the parent page

Returns:

the parent page

addPublicPage

void addPublicPage(Page page)
                   throws Exception

Add a public wiki page

Parameters:

page -

Throws:

Exception

setNonePermission

void setNonePermission()
                       throws Exception

Reset page permisison

Throws:

Exception