com.iknowbase.api.presentationservices.client

Interface SpringMvcPageEngineClient

public interface SpringMvcPageEngineClient

SpringMvcPageEngineClient is a client service object enabling easy access to page engine functionality.

Method Summary

Modifier and Type	Method and Description
View	createPageView(String targetPath, String embeddableContent) Creates a View that will embed the supplied content into a given iKnowBase page, using the path of the page as a key.
View	createStringView(String content) Creates a view which will render a given content string as text/html, for easy integration with Spring MVC patterns.
View	createStringView(String content, String contentType) Creates a View which will render a given content string using a given contentType, for easy integration with Spring MVC patterns.
String	renderPage(String path, String clientPageContent) Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page.
String	renderTemplate(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.
View	submitPage(String path) Deprecated.

Method Detail

renderTemplate

String renderTemplate(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(String path,
                  String clientPageContent)

Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page.

Parameters:

path - path to iKnowBase page, as defined in Development Studio

clientPageContent - string containing content to be exposed as client page

Returns:

String representing rendered page content

submitPage

@Deprecated
View submitPage(String path)

Deprecated.

Submits post data to an iKnowBase page for processing. Returns null if the post data was not processed, or if processing the data is complete, and the client can continue with whatever processing it prefers. Returns a non-null View if processing should continue there.

Parameters:

path - path to iKnowBase page, as defined in Development Studio

Returns:

View representing rendered page content

createPageView

View createPageView(String targetPath,
                    String embeddableContent)

Creates a View that will embed the supplied content into a given iKnowBase page, using the path of the page as a key. From the perspective of the iKnowBase page, the embeddable content is available using the same mechanism as from any other client page.

createStringView

View createStringView(String content,
                      String contentType)

Creates a View which will render a given content string using a given contentType, for easy integration with Spring MVC patterns.

The View will render using UTF-8 encoding, unless the contentType also contains a charset-specification. UTF-8 is highly recommended.

Parameters:

content - the content to be rendered by the view

contentType - the content type to be rendered

Returns:

the View that will render the content

createStringView

View createStringView(String content)

Creates a view which will render a given content string as text/html, for easy integration with Spring MVC patterns.

Parameters:

content - the content to be rendered by the view

Returns:

the View that will render the content