org.sakaiproject.portal.render.api

Interface RenderResult

public interface RenderResult

Results rendered from the portlet must impliment this interface

Since:

Sakai 2.2.4

Version:

$Rev$

Author:

ieb

Method Summary

Modifier and Type	Method and Description
String	getContent() get the portlet content
String	getHead()
String	getJSR168EditUrl() get the JSR168 Edit Url
String	getJSR168HelpUrl() get the JSR168 Help Url
String	getTitle() get the portlet title
void	setContent(String content) set the portlet content

Method Detail

getTitle

String getTitle()
         throws ToolRenderException

get the portlet title

Returns:

Throws:

ToolRenderException - if the title can not be retrieved

getContent

String getContent()
           throws ToolRenderException

get the portlet content

Returns:

content

Throws:

ToolRenderException - if the content can not be rendered

setContent

void setContent(String content)

set the portlet content

getJSR168HelpUrl

String getJSR168HelpUrl()
                 throws ToolRenderException

get the JSR168 Help Url

Returns:

Url

Throws:

ToolRenderException - if the content can not be rendered

getJSR168EditUrl

String getJSR168EditUrl()
                 throws ToolRenderException

get the JSR168 Edit Url

Returns:

Url

Throws:

ToolRenderException - if the content can not be rendered

getHead

String getHead()

Returns: