org.sakaiproject.portal.render.portlet

Class PortletToolRenderService

java.lang.Object

org.sakaiproject.portal.render.portlet.PortletToolRenderService

All Implemented Interfaces:

org.sakaiproject.portal.render.api.ToolRenderService

public class PortletToolRenderService
extends Object
implements org.sakaiproject.portal.render.api.ToolRenderService

Since:

Sakai 2.4

Version:

$Rev: 109718 $

Author:

ddwolf, ieb, csev

Constructor Summary

Constructors

Constructor and Description
PortletToolRenderService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(org.sakaiproject.portal.api.Portal portal, org.sakaiproject.site.api.ToolConfiguration configuration, HttpServletRequest request, HttpServletResponse response, ServletContext context)
org.sakaiproject.portal.api.PortalService	getPortalService()
org.apache.pluto.descriptors.portlet.PortletDD	getPortletDD(org.sakaiproject.tool.api.Placement placement)
PortletStateEncoder	getPortletStateEncoder()
boolean	isPortletModeAllowed(org.sakaiproject.tool.api.Placement placement, String mode)
boolean	preprocess(org.sakaiproject.portal.api.Portal portal, HttpServletRequest request, HttpServletResponse response, ServletContext context)
org.sakaiproject.portal.render.api.RenderResult	render(org.sakaiproject.portal.api.Portal portal, org.sakaiproject.site.api.ToolConfiguration toolConfiguration, HttpServletRequest request, HttpServletResponse response, ServletContext context)
void	reset(org.sakaiproject.site.api.ToolConfiguration configuration)
void	setPortalService(org.sakaiproject.portal.api.PortalService portalService)
void	setPortletStateEncoder(PortletStateEncoder portletStateEncoder)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletToolRenderService

public PortletToolRenderService()

Method Detail

getPortletStateEncoder

public PortletStateEncoder getPortletStateEncoder()

setPortletStateEncoder

public void setPortletStateEncoder(PortletStateEncoder portletStateEncoder)

preprocess

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

Specified by:

preprocess in interface org.sakaiproject.portal.render.api.ToolRenderService

Throws:

IOException

render

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

Specified by:

render in interface org.sakaiproject.portal.render.api.ToolRenderService

Throws:

IOException

accept

public boolean accept(org.sakaiproject.portal.api.Portal portal,
             org.sakaiproject.site.api.ToolConfiguration configuration,
             HttpServletRequest request,
             HttpServletResponse response,
             ServletContext context)

Specified by:

accept in interface org.sakaiproject.portal.render.api.ToolRenderService

reset

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

Specified by:

reset in interface org.sakaiproject.portal.render.api.ToolRenderService

getPortletDD

public org.apache.pluto.descriptors.portlet.PortletDD getPortletDD(org.sakaiproject.tool.api.Placement placement)

isPortletModeAllowed

public boolean isPortletModeAllowed(org.sakaiproject.tool.api.Placement placement,
                           String mode)

getPortalService

public org.sakaiproject.portal.api.PortalService getPortalService()

Returns:

the portalService

setPortalService

public void setPortalService(org.sakaiproject.portal.api.PortalService portalService)

Parameters:

portalService - the portalService to set