01: package org.sakaiproject.portal.render.api;
02:
03: /**
04: * Results rendered from the portlet must impliment this interface
05: *
06: * @author ieb
07: * @since Sakai 2.2.4
08: * @version $Rev: 22653 $
09: */
10: public interface RenderResult {
11:
12: /**
13: * get the portlet title
14: *
15: * @return
16: * @throws ToolRenderException
17: * if the title can not be retrieved
18: */
19: String getTitle() throws ToolRenderException;
20:
21: /**
22: * get the portlet content
23: *
24: * @return content
25: * @throws ToolRenderException
26: * if the content can not be rendered
27: */
28: String getContent() throws ToolRenderException;
29:
30: /**
31: * get the JSR168 Help Url
32: *
33: * @return Url
34: * @throws ToolRenderException
35: * if the content can not be rendered
36: */
37: String getJSR168HelpUrl() throws ToolRenderException;
38:
39: /**
40: * get the JSR168 Edit Url
41: *
42: * @return Url
43: * @throws ToolRenderException
44: * if the content can not be rendered
45: */
46: String getJSR168EditUrl() throws ToolRenderException;
47: }
|