001    /**
002     * Copyright (c) 2000-2013 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.jsp.PageContext;
025    
026    /**
027     * @author Eduardo Garcia
028     */
029    public interface PortletDisplayTemplate {
030    
031            public static final String DISPLAY_STYLE_PREFIX = "ddmTemplate_";
032    
033            public DDMTemplate fetchDDMTemplate(long groupId, String displayStyle);
034    
035            public long getDDMTemplateGroupId(long groupId);
036    
037            public String getDDMTemplateUuid(String displayStyle);
038    
039            public long getPortletDisplayTemplateDDMTemplateId(
040                    long groupId, String displayStyle);
041    
042            public List<TemplateHandler> getPortletDisplayTemplateHandlers();
043    
044            public Map<String, TemplateVariableGroup> getTemplateVariableGroups(
045                    String language);
046    
047            public String renderDDMTemplate(
048                            PageContext pageContext, long ddmTemplateId, List<?> entries)
049                    throws Exception;
050    
051            public String renderDDMTemplate(
052                            PageContext pageContext, long ddmTemplateId, List<?> entries,
053                            Map<String, Object> contextObjects)
054                    throws Exception;
055    
056    }