com.iknowbase.api.presentationservices.client

Interface SpringMvcPageEngineClient

All Superinterfaces:

PageEngineClient

public interface SpringMvcPageEngineClient
extends PageEngineClient

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

Method Summary

Modifier and Type	Method and Description
org.springframework.web.servlet.View	createPageView(java.lang.String targetPath, java.lang.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.
org.springframework.web.servlet.View	createStringView(java.lang.String content) Creates a view which will render a given content string as text/html, for easy integration with Spring MVC patterns.
org.springframework.web.servlet.View	createStringView(java.lang.String content, java.lang.String contentType) Creates a View which will render a given content string using a given contentType, for easy integration with Spring MVC patterns.
org.springframework.web.servlet.View	submitPage(java.lang.String path) Deprecated.

Methods inherited from interface com.iknowbase.api.presentationservices.client.PageEngineClient

renderPage, renderTemplate

Method Detail

submitPage

@Deprecated
org.springframework.web.servlet.View submitPage(java.lang.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

org.springframework.web.servlet.View createPageView(java.lang.String targetPath,
                                                    java.lang.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

org.springframework.web.servlet.View createStringView(java.lang.String content,
                                                      java.lang.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

org.springframework.web.servlet.View createStringView(java.lang.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