org.jboss.wiki
Interface MediaDataSource

public interface MediaDataSource

Author:

Tomasz Szymanski

Field Summary

static int	EDITABLE
static java.lang.String	mediaTrashName
static int	VIEWABLE

Method Summary

boolean	deletePage(java.lang.String pageName) Deletes (or moves to trash) given page
java.util.Set<java.lang.String>	getAllPageNames() Gets all page names.
void	getContentAtVersion(org.jboss.wiki.WikiPage page, boolean loadContent, int version) Loads content to given page at given version.
org.jboss.wiki.WikiPage	getPage(java.lang.String pageName) Gets page with given page name.
org.jboss.wiki.WikiPage	getPage(java.lang.String pageName, java.lang.String languageCode) Gets page with given page name and language code.
org.jboss.wiki.WikiPage	getPageAtVersion(org.jboss.wiki.WikiPage originPage, boolean loadContent, int version) Gets page at given version and with given language code.
org.jboss.wiki.WikiPage	getPageAtVersion(org.jboss.wiki.WikiPage originPage, boolean loadContent, java.lang.String languageCode, int version) Gets page at given version and with given language code.
int	getPageMod(java.lang.String pageName) Gets rights (editable and/or viewable) for a given page.
java.util.Set<java.lang.String>	getPagesFor(java.lang.String pageName) Gets subpages for a given page.
boolean	pageExists(java.lang.String pageName) Checks if given page exists.
boolean	postGet() This function is executed after every page get.
boolean	postSave() This function is exeuted after saving page.
boolean	preGet() This function is executed before every page get.
boolean	preSave() This function is executed before every save.
boolean	savePage(java.lang.String uid, org.jboss.wiki.WikiPage page, java.lang.String languageCode) Saves given given wikiPage with language code please note languages are still not supported
void	setPageMod(java.lang.String pageName, int mods) Set right for a page.
void	setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine) Sets wikiEngine reference

Field Detail

EDITABLE

static final int EDITABLE

See Also:

Constant Field Values

VIEWABLE

static final int VIEWABLE

See Also:

Constant Field Values

mediaTrashName

static final java.lang.String mediaTrashName

See Also:

Constant Field Values

Method Detail

preSave

boolean preSave()

This function is executed before every save.

Returns:

true if preSafe function succeded. False if not.

savePage

boolean savePage(java.lang.String uid,
                 org.jboss.wiki.WikiPage page,
                 java.lang.String languageCode)

Saves given given wikiPage with language code please note languages are still not supported

Parameters:

page - Page to save (with changed version number, author and content)

uid - Page's uid

languageCode - langague code

Returns:

true if page was succesfully saved

postSave

boolean postSave()

This function is exeuted after saving page.

Returns:

true if succeded. False otherwise.

preGet

boolean preGet()

This function is executed before every page get.

Returns:

true if succeded. False otherwise.

getPage

org.jboss.wiki.WikiPage getPage(java.lang.String pageName)

Gets page with given page name.

Parameters:

pageName - Name of the page to get.

Returns:

true if succeded. False otherwise.

postGet

boolean postGet()

This function is executed after every page get.

Returns:

Desired wiki page or null if it doesn't exists.

getPage

org.jboss.wiki.WikiPage getPage(java.lang.String pageName,
                                java.lang.String languageCode)

Gets page with given page name and language code. please note languages are still not supported

Parameters:

pageName - Name of the page to get.

languageCode - Language code of the page.

Returns:

Desired wiki page or null if it doesn't exists.

getPageAtVersion

org.jboss.wiki.WikiPage getPageAtVersion(org.jboss.wiki.WikiPage originPage,
                                         boolean loadContent,
                                         java.lang.String languageCode,
                                         int version)

Gets page at given version and with given language code. please note languages are still not supported

Parameters:

originPage - Original page to get version for.

loadContent - If true returned page will be loaded with content.

languageCode - Language code of the page.

version - Version of the page to load.

Returns:

Desired wiki page or null if it doesn't exists. Page will be loaded with content or not due to loadContent.

getPageAtVersion

org.jboss.wiki.WikiPage getPageAtVersion(org.jboss.wiki.WikiPage originPage,
                                         boolean loadContent,
                                         int version)

Gets page at given version and with given language code.

Parameters:

originPage - Original page to get version for.

loadContent - If true returned page will be loaded with content.

version - Version of the page to load.

Returns:

Desired wiki page or null if it doesn't exists. Page will be loaded with content or not due to loadContent.

pageExists

boolean pageExists(java.lang.String pageName)

Checks if given page exists.

Parameters:

pageName - Name of the page you are looking for.

Returns:

true if page exists. False otherwise.

getContentAtVersion

void getContentAtVersion(org.jboss.wiki.WikiPage page,
                         boolean loadContent,
                         int version)

Loads content to given page at given version.

Parameters:

page - Page to load content to.

loadContent - If true it will load content. If false it will do nothing.

version - Version of the page to load.

getAllPageNames

java.util.Set<java.lang.String> getAllPageNames()

Gets all page names.

Returns:

Set of page names.

getPagesFor

java.util.Set<java.lang.String> getPagesFor(java.lang.String pageName)

Gets subpages for a given page.

Parameters:

pageName - Page name to get subpages list for.

Returns:

List of subpages for a page pageName

getPageMod

int getPageMod(java.lang.String pageName)

Gets rights (editable and/or viewable) for a given page. Result is sum of apropriate static variables EDITABLE and VIEWABLE

Parameters:

pageName - Name of the page to get rights for.

Returns:

Sum of apropriate static variables EDITABLE and VIEWABLE

setPageMod

void setPageMod(java.lang.String pageName,
                int mods)

Set right for a page.

Parameters:

pageName - Name of the page to set right for.

mods - Sum of apropriate static variables EDITABLE and VIEWABLE

deletePage

boolean deletePage(java.lang.String pageName)

Deletes (or moves to trash) given page

Parameters:

pageName - Name of the page to delete.

setWikiEngine

void setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine)

Sets wikiEngine reference

Parameters:

wikiEngine -