001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.bean;
016    
017    import javax.portlet.PortletRequest;
018    import javax.portlet.PortletResponse;
019    
020    import javax.servlet.http.HttpServletRequest;
021    import javax.servlet.http.HttpServletResponse;
022    
023    /**
024     * @author Raymond Augé
025     */
026    public interface Renderer {
027    
028            public static final String RENDERER_TEMPLATE_PREFIX = "renderer.template.";
029    
030            public String renderBean(
031                            HttpServletRequest request, HttpServletResponse response,
032                            Object bean)
033                    throws RendererException;
034    
035            public String renderBean(
036                            HttpServletRequest request, HttpServletResponse response,
037                            Object bean, String varientSuffix)
038                    throws RendererException;
039    
040            public String renderBean(
041                            HttpServletRequest request, HttpServletResponse response,
042                            String servletContextName, Object bean)
043                    throws RendererException;
044    
045            public String renderBean(
046                            HttpServletRequest request, HttpServletResponse response,
047                            String servletContextName, Object bean, String varientSuffix)
048                    throws RendererException;
049    
050            public String renderBean(
051                            PortletRequest portletRequest, PortletResponse portletResponse,
052                            Object bean)
053                    throws RendererException;
054    
055            public String renderBean(
056                            PortletRequest portletRequest, PortletResponse portletResponse,
057                            Object bean, String varientSuffix)
058                    throws RendererException;
059    
060            public String renderBean(
061                            PortletRequest portletRequest, PortletResponse portletResponse,
062                            String servletContextName, Object bean)
063                    throws RendererException;
064    
065            public String renderBean(
066                            PortletRequest portletRequest, PortletResponse portletResponse,
067                            String servletContextName, Object bean, String varientSuffix)
068                    throws RendererException;
069    
070            public String renderEntity(
071                            HttpServletRequest request, HttpServletResponse response,
072                            String className, Object classPK)
073                    throws RendererException;
074    
075            public String renderEntity(
076                            HttpServletRequest request, HttpServletResponse response,
077                            String className, Object classPK, String varientSuffix)
078                    throws RendererException;
079    
080            public String renderEntity(
081                            HttpServletRequest request, HttpServletResponse response,
082                            String servletContextName, String className, Object classPK)
083                    throws RendererException;
084    
085            public String renderEntity(
086                            HttpServletRequest request, HttpServletResponse response,
087                            String servletContextName, String className, Object classPK,
088                            String varientSuffix)
089                    throws RendererException;
090    
091            public String renderEntity(
092                            PortletRequest portletRequest, PortletResponse portletResponse,
093                            String className, Object classPK)
094                    throws RendererException;
095    
096            public String renderEntity(
097                            PortletRequest portletRequest, PortletResponse portletResponse,
098                            String className, Object classPK, String varientSuffix)
099                    throws RendererException;
100    
101            public String renderEntity(
102                            PortletRequest portletRequest, PortletResponse portletResponse,
103                            String servletContextName, String className, Object classPK)
104                    throws RendererException;
105    
106            public String renderEntity(
107                            PortletRequest portletRequest, PortletResponse portletResponse,
108                            String servletContextName, String className, Object classPK,
109                            String varientSuffix)
110                    throws RendererException;
111    
112    }