001    /**
002     * Copyright (c) 2000-present 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.portlet.portletdisplaytemplate.util;
016    
017    import com.liferay.portal.kernel.template.TemplateHandler;
018    import com.liferay.portal.kernel.template.TemplateVariableGroup;
019    import com.liferay.portlet.dynamicdatamapping.model.DDMTemplate;
020    
021    import java.util.List;
022    import java.util.Map;
023    
024    import javax.servlet.http.HttpServletRequest;
025    import javax.servlet.http.HttpServletResponse;
026    
027    /**
028     * @author Eduardo Garcia
029     */
030    public interface PortletDisplayTemplate {
031    
032            public static final String DISPLAY_STYLE_PREFIX = "ddmTemplate_";
033    
034            public DDMTemplate fetchDDMTemplate(long groupId, String displayStyle);
035    
036            public long getDDMTemplateGroupId(long groupId);
037    
038            public String getDDMTemplateKey(String displayStyle);
039    
040            @Deprecated
041            public String getDDMTemplateUuid(String displayStyle);
042    
043            public DDMTemplate getDefaultPortletDisplayTemplateDDMTemplate(
044                    long groupId, long classNameId);
045    
046            public String getDisplayStyle(String ddmTemplateKey);
047    
048            public DDMTemplate getPortletDisplayTemplateDDMTemplate(
049                    long groupId, long classNameId, String displayStyle);
050    
051            public DDMTemplate getPortletDisplayTemplateDDMTemplate(
052                    long groupId, long classNameId, String displayStyle,
053                    boolean useDefault);
054    
055            @Deprecated
056            public long getPortletDisplayTemplateDDMTemplateId(
057                    long groupId, String displayStyle);
058    
059            public List<TemplateHandler> getPortletDisplayTemplateHandlers();
060    
061            public Map<String, TemplateVariableGroup> getTemplateVariableGroups(
062                    String language);
063    
064            public String renderDDMTemplate(
065                            HttpServletRequest request, HttpServletResponse response,
066                            DDMTemplate ddmTemplate, List<?> entries)
067                    throws Exception;
068    
069            public String renderDDMTemplate(
070                            HttpServletRequest request, HttpServletResponse response,
071                            DDMTemplate ddmTemplate, List<?> entries,
072                            Map<String, Object> contextObjects)
073                    throws Exception;
074    
075            public String renderDDMTemplate(
076                            HttpServletRequest request, HttpServletResponse response,
077                            long ddmTemplateId, List<?> entries)
078                    throws Exception;
079    
080            public String renderDDMTemplate(
081                            HttpServletRequest request, HttpServletResponse response,
082                            long ddmTemplateId, List<?> entries,
083                            Map<String, Object> contextObjects)
084                    throws Exception;
085    
086    }