Package org.sakaiproject.portal.render.api

Interface ToolRenderService

public interface ToolRenderService

Service responsible for preprocessing and rendering tools within a Sakai portal.

Since:

Sakai 2.2.3

Version:

$Rev$

Method Summary

Modifier and Type	Method	Description
boolean	accept(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)	The render service will accept responsibility for a tool.
boolean	preprocess(org.sakaiproject.portal.api.Portal portal, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)	Perfrorm any preperatory processing for the specified tool.
RenderResult	render(org.sakaiproject.portal.api.Portal portal, org.sakaiproject.site.api.ToolConfiguration toolConfiguration, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)	Render the tool.
void	reset(org.sakaiproject.site.api.ToolConfiguration configuration)	reset the ToolConfiguration/Placement associated with the config

Method Detail

preprocess

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

Perfrorm any preperatory processing for the specified tool.

Parameters:

request - the servlet request

response - the servlet response.

context - the portal servlet context

Returns:

indicates whether or not processing should be continued.

Throws:

IOException - if an error occurs during preprocessing.

render

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

Render the tool.

Parameters:

toolConfiguration -

request -

response -

Throws:

IOException

ToolRenderException

accept

boolean accept(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)

The render service will accept responsibility for a tool. This enables a controller to check if the render service can manage the tool

Parameters:

configuration - tool configuration for the tool in question

request -

response -

context - - this is the servlet context handling the request (ie the portal)

Returns:

reset

void reset(org.sakaiproject.site.api.ToolConfiguration configuration)

reset the ToolConfiguration/Placement associated with the config

Parameters:

configuration -