org.sakaiproject.portal.portlet

Interface PortletRenderEngine

All Known Implementing Classes:

VelocityPortletRenderEngine

public interface PortletRenderEngine

Repesents the API used by the protal to comunicate with the RenderEngine implimentation.

Author:

ieb

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RENDER_ENGINE the default render engine impliemtnation

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Initialise the render engine
PortletRenderContext	newRenderContext(javax.portlet.RenderRequest request) generate a non thread safe render context for the current request/thread/operation
void	render(String template, PortletRenderContext rcontext, Writer out) Render a PortalRenderContext against a template.

Field Detail

DEFAULT_RENDER_ENGINE

static final String DEFAULT_RENDER_ENGINE

the default render engine impliemtnation

Method Detail

init

void init()
          throws Exception

Initialise the render engine

Throws:

Exception

newRenderContext

PortletRenderContext newRenderContext(javax.portlet.RenderRequest request)

generate a non thread safe render context for the current request/thread/operation

Parameters:

request -

Returns:

render

void render(String template,
          PortletRenderContext rcontext,
          Writer out)
            throws Exception

Render a PortalRenderContext against a template. The real template may be based on a skining name, out output will be send to the Writer

Parameters:

template -

rcontext -

out -

Throws:

Exception