1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.bean;
24  
25  import javax.portlet.PortletRequest;
26  import javax.portlet.PortletResponse;
27  
28  import javax.servlet.http.HttpServletRequest;
29  import javax.servlet.http.HttpServletResponse;
30  
31  /**
32   * <a href="Renderer.java.html"><b><i>View Source</i></b></a>
33   *
34   * @author Raymond Augé
35   *
36   */
37  public interface Renderer {
38  
39      public static final String RENDERER_TEMPLATE_PREFIX =
40          "renderer.template.";
41  
42      public String renderBean(
43              HttpServletRequest request, HttpServletResponse response,
44              Object bean)
45          throws RendererException;
46  
47      public String renderBean(
48              HttpServletRequest request, HttpServletResponse response,
49              Object bean, String varientSuffix)
50          throws RendererException;
51  
52      public String renderBean(
53              HttpServletRequest request, HttpServletResponse response,
54              String servletContextName, Object bean)
55          throws RendererException;
56  
57      public String renderBean(
58              HttpServletRequest request, HttpServletResponse response,
59              String servletContextName, Object bean, String varientSuffix)
60          throws RendererException;
61  
62      public String renderBean(
63              PortletRequest portletRequest, PortletResponse portletResponse,
64              Object bean)
65          throws RendererException;
66  
67      public String renderBean(
68              PortletRequest portletRequest, PortletResponse portletResponse,
69              Object bean, String varientSuffix)
70          throws RendererException;
71  
72      public String renderBean(
73              PortletRequest portletRequest, PortletResponse portletResponse,
74              String servletContextName, Object bean)
75          throws RendererException;
76  
77      public String renderBean(
78              PortletRequest portletRequest, PortletResponse portletResponse,
79              String servletContextName, Object bean, String varientSuffix)
80          throws RendererException;
81  
82      public String renderEntity(
83              HttpServletRequest request, HttpServletResponse response,
84              String className, Object classPK)
85          throws RendererException;
86  
87      public String renderEntity(
88              HttpServletRequest request, HttpServletResponse response,
89              String className, Object classPK, String varientSuffix)
90          throws RendererException;
91  
92      public String renderEntity(
93              HttpServletRequest request, HttpServletResponse response,
94              String servletContextName, String className, Object classPK)
95          throws RendererException;
96  
97      public String renderEntity(
98              HttpServletRequest request, HttpServletResponse response,
99              String servletContextName, String className, Object classPK,
100             String varientSuffix)
101         throws RendererException;
102 
103     public String renderEntity(
104             PortletRequest portletRequest, PortletResponse portletResponse,
105             String className, Object classPK)
106         throws RendererException;
107 
108     public String renderEntity(
109             PortletRequest portletRequest, PortletResponse portletResponse,
110             String className, Object classPK, String varientSuffix)
111         throws RendererException;
112 
113     public String renderEntity(
114             PortletRequest portletRequest, PortletResponse portletResponse,
115             String servletContextName, String className, Object classPK)
116         throws RendererException;
117 
118     public String renderEntity(
119             PortletRequest portletRequest, PortletResponse portletResponse,
120             String servletContextName, String className, Object classPK,
121             String varientSuffix)
122         throws RendererException;
123 
124 }