Package org.sakaiproject.portal.render.cover

Class ToolRenderService

java.lang.Object

org.sakaiproject.portal.render.cover.ToolRenderService

public class ToolRenderService
extends Object

ToolRenderService is a static cover for the ToolRenderService

Since:

Sakai 2.2.4

Version:

$Rev$

Constructor Summary

Constructors

Constructor	Description
ToolRenderService()

Method Summary

Modifier and Type	Method	Description
static ToolRenderService	getInstance()	Access the component instance: special cover only method.
static boolean	preprocess(org.sakaiproject.portal.api.Portal portal, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)	Preprocess the given request.
static RenderResult	render(org.sakaiproject.portal.api.Portal portal, org.sakaiproject.site.api.ToolConfiguration configuration, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToolRenderService

public ToolRenderService()

Method Detail

getInstance

public static ToolRenderService getInstance()

Access the component instance: special cover only method.

Returns:

the component instance.

preprocess

public static boolean preprocess(org.sakaiproject.portal.api.Portal portal,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 javax.servlet.ServletContext context)
                          throws IOException

Preprocess the given request. Instructs the service to perform any preprocessing which may affect the state of the portlets (e.g. how they are rendered).

Parameters:

request - the current servlet request

response - the current servlet response

context - the application context

Returns:

true, if and only if processing should continue.

Throws:

IOException - if an error occurs during preprocessing

render

public static RenderResult render(org.sakaiproject.portal.api.Portal portal,
                                  org.sakaiproject.site.api.ToolConfiguration configuration,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  javax.servlet.ServletContext context)
                           throws IOException

Parameters:

configuration - the tool which should be rendered

request - the current servlet request

response - the current servlet response

context - the application context

Returns:

a rendered(able) content

Throws:

IOException - if an error occurs during processing.