uk.ac.cam.caret.sakai.rwiki.tool.api

Interface ToolRenderService

All Known Implementing Classes:

ToolRenderServiceImpl

public interface ToolRenderService

Method Summary

Methods

Modifier and Type	Method and Description
String	renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo) Renders a view of the page
String	renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, boolean b)
String	renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, String defaultRealm) Renders a view of the page
String	renderPrintPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, boolean withBreadcrumbs) Renders a print view of the page
String	renderPrintPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, String realm, boolean withBreadcrumbs) Renders a print view of the page
String	renderPublicPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, boolean withBreadcrumbs) Renders a public view of the page
String	renderPublicPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, String realm, boolean withBreadcrumbs) Renders a public view of the page

Method Detail

renderPublicPage

String renderPublicPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                      boolean withBreadcrumbs)

Renders a public view of the page

Parameters:

rwo - the RWiki object

user - The user

Returns:

and string containing the rendered content

renderPrintPage

String renderPrintPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                     String realm,
                     boolean withBreadcrumbs)

Renders a print view of the page

Parameters:

rwo - The RWikiObject representing the page

user - The user making the request

realm - The default realm to render in

Returns:

an string representing the rendered content

renderPrintPage

String renderPrintPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                     boolean withBreadcrumbs)

Renders a print view of the page

Parameters:

rwo - the RWiki object

user - The user

Returns:

and string containing the rendered content

renderPublicPage

String renderPublicPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                      String realm,
                      boolean withBreadcrumbs)

Renders a public view of the page

Parameters:

rwo - The RWikiObject representing the page

user - The user making the request

realm - The default realm to render in

Returns:

an string representing the rendered content

renderPage

String renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Renders a view of the page

Parameters:

rwo - the RWiki object

user - The user

Returns:

and string containing the rendered content

renderPage

String renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                String defaultRealm)

Renders a view of the page

Parameters:

rwo - The RWikiObject representing the page

user - The user making the request

defaultRealm - The default realm to render in

Returns:

an string representing the rendered content

renderPage

String renderPage(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
                boolean b)