Package com.iknowbase.api.presentationservices.page

Interface PageService

public interface PageService

A service managing the page services, in particular providing access to TemplateRunner, PortletRunner and PageRunner objects.

Method Summary

Modifier and Type	Method	Description
PortletRunner	portletRunner()	Returns a PortletRunner useful for running a portlet
String	renderPage(PresentationServicesClient client, String uri, String clientPageContent)	Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page.
String	renderTemplate(PresentationServicesClient client, String templateFile, Map<String,?> model)	Renders a file-based template using both the iKnowBase-provided model objects and the model supplied with the method call, giving priority to the latter.
PageRunner	runner()	Returns a PageRunner useful for running a page

Method Detail

runner

PageRunner runner()

Returns a PageRunner useful for running a page

Returns:

a PageRunner

portletRunner

PortletRunner portletRunner()

Returns a PortletRunner useful for running a portlet

Returns:

a PortletRunner

renderTemplate

String renderTemplate(PresentationServicesClient client,
                      String templateFile,
                      Map<String,?> model)

Renders a file-based template using both the iKnowBase-provided model objects and the model supplied with the method call, giving priority to the latter.

Parameters:

templateFile - filename of template file

model - map of model objects to use

Returns:

String content representing rendered template

renderPage

String renderPage(PresentationServicesClient client,
                  String uri,
                  String clientPageContent)

Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page. The uri should be an absolute URI, without protocol or server name, as defined in iKnowBase Development Studio. The uri may include parameters, as in /SYSTEST/Page/FreemarkerRequestModel?testcase=testcase03&p0=v0&p1=v1&p1=v1a&p2=v2

Parameters:

uri - path to iKnowBase page, optionally including arguments.

clientPageContent - string containing content to be exposed as client page

Returns:

String representing rendered page content