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  public interface Renderer {
37  
38      public static final String RENDERER_TEMPLATE_PREFIX =
39          "renderer.template.";
40  
41      public String renderBean(
42              HttpServletRequest request, HttpServletResponse response,
43              Object bean)
44          throws RendererException;
45  
46      public String renderBean(
47              HttpServletRequest request, HttpServletResponse response,
48              Object bean, String varientSuffix)
49          throws RendererException;
50  
51      public String renderBean(
52              HttpServletRequest request, HttpServletResponse response,
53              String servletContextName, Object bean)
54          throws RendererException;
55  
56      public String renderBean(
57              HttpServletRequest request, HttpServletResponse response,
58              String servletContextName, Object bean, String varientSuffix)
59          throws RendererException;
60  
61      public String renderBean(
62              PortletRequest portletRequest, PortletResponse portletResponse,
63              Object bean)
64          throws RendererException;
65  
66      public String renderBean(
67              PortletRequest portletRequest, PortletResponse portletResponse,
68              Object bean, String varientSuffix)
69          throws RendererException;
70  
71      public String renderBean(
72              PortletRequest portletRequest, PortletResponse portletResponse,
73              String servletContextName, Object bean)
74          throws RendererException;
75  
76      public String renderBean(
77              PortletRequest portletRequest, PortletResponse portletResponse,
78              String servletContextName, Object bean, String varientSuffix)
79          throws RendererException;
80  
81      public String renderEntity(
82              HttpServletRequest request, HttpServletResponse response,
83              String className, Object classPK)
84          throws RendererException;
85  
86      public String renderEntity(
87              HttpServletRequest request, HttpServletResponse response,
88              String className, Object classPK, String varientSuffix)
89          throws RendererException;
90  
91      public String renderEntity(
92              HttpServletRequest request, HttpServletResponse response,
93              String servletContextName, String className, Object classPK)
94          throws RendererException;
95  
96      public String renderEntity(
97              HttpServletRequest request, HttpServletResponse response,
98              String servletContextName, String className, Object classPK,
99              String varientSuffix)
100         throws RendererException;
101 
102     public String renderEntity(
103             PortletRequest portletRequest, PortletResponse portletResponse,
104             String className, Object classPK)
105         throws RendererException;
106 
107     public String renderEntity(
108             PortletRequest portletRequest, PortletResponse portletResponse,
109             String className, Object classPK, String varientSuffix)
110         throws RendererException;
111 
112     public String renderEntity(
113             PortletRequest portletRequest, PortletResponse portletResponse,
114             String servletContextName, String className, Object classPK)
115         throws RendererException;
116 
117     public String renderEntity(
118             PortletRequest portletRequest, PortletResponse portletResponse,
119             String servletContextName, String className, Object classPK,
120             String varientSuffix)
121         throws RendererException;
122 
123 }