org.sakaiproject.portal.portlet

Interface PortletRenderContext

All Known Implementing Classes:

VelocityPortletRenderContext

public interface PortletRenderContext

This interface represent the Render Context, it allows the portal implementation to put values into the render context. There is a utility dump method to dump the context. Instances of this class should be created per request via an Implimention of the RenderContextEngine

Author:

ieb

Method Summary

Methods

Modifier and Type	Method and Description
String	dump() Converr the render context to a string suitable for dumping to a log file or console.
void	put(String string, Object value) Set a value agaaisnt a Key, normally a value might be a String, Collection or a Map, but depending on the render engine technology other objects may be acceptable.
boolean	uses(String includeOption) Return true if the context needs this part of the portal

Method Detail

put

void put(String string,
       Object value)

Set a value agaaisnt a Key, normally a value might be a String, Collection or a Map, but depending on the render engine technology other objects may be acceptable.

Parameters:

string -

value -

dump

String dump()

Converr the render context to a string suitable for dumping to a log file or console.

Returns:

uses

boolean uses(String includeOption)

Return true if the context needs this part of the portal

Parameters:

includeOption -

Returns: