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.dynamicdatamapping.util;
016    
017    import com.liferay.portal.kernel.portlet.LiferayPortletRequest;
018    import com.liferay.portal.kernel.portlet.LiferayPortletResponse;
019    import com.liferay.portal.security.permission.PermissionChecker;
020    import com.liferay.portal.theme.ThemeDisplay;
021    import com.liferay.portlet.dynamicdatamapping.model.DDMStructure;
022    import com.liferay.portlet.dynamicdatamapping.model.DDMTemplate;
023    
024    import java.util.Locale;
025    import java.util.Set;
026    
027    /**
028     * @author Eduardo Garcia
029     */
030    public interface DDMDisplay {
031    
032            public String getAddStructureActionId();
033    
034            public String getAddTemplateActionId();
035    
036            public String getAvailableFields();
037    
038            public String getEditStructureDefaultValuesURL(
039                            LiferayPortletRequest liferayPortletRequest,
040                            LiferayPortletResponse liferayPortletResponse,
041                            DDMStructure structure, String redirectURL, String backURL)
042                    throws Exception;
043    
044            public String getEditTemplateBackURL(
045                            LiferayPortletRequest liferayPortletRequest,
046                            LiferayPortletResponse liferayPortletResponse, long classNameId,
047                            long classPK, String portletResource)
048                    throws Exception;
049    
050            public String getEditTemplateTitle(
051                    DDMStructure structure, DDMTemplate template, Locale locale);
052    
053            public String getEditTemplateTitle(long classNameId, Locale locale);
054    
055            public String getPortletId();
056    
057            public String getResourceName();
058    
059            public String getResourceName(long classNameId);
060    
061            public String getStorageType();
062    
063            public String getStructureName(Locale locale);
064    
065            public String getStructureType();
066    
067            public long[] getTemplateClassNameIds(long classNameId);
068    
069            public long[] getTemplateClassPKs(
070                            long companyId, long classNameId, long classPK)
071                    throws Exception;
072    
073            public long[] getTemplateGroupIds(
074                            ThemeDisplay themeDisplay, boolean showGlobalScope)
075                    throws Exception;
076    
077            public long getTemplateHandlerClassNameId(
078                    DDMTemplate template, long classNameId);
079    
080            public Set<String> getTemplateLanguageTypes();
081    
082            public String getTemplateMode();
083    
084            public String getTemplateType();
085    
086            public String getTemplateType(DDMTemplate template, Locale locale);
087    
088            public String getViewTemplatesBackURL(
089                            LiferayPortletRequest liferayPortletRequest,
090                            LiferayPortletResponse liferayPortletResponse, long classPK)
091                    throws Exception;
092    
093            public Set<String> getViewTemplatesExcludedColumnNames();
094    
095            public String getViewTemplatesTitle(
096                    DDMStructure structure, boolean controlPanel, Locale locale);
097    
098            public String getViewTemplatesTitle(DDMStructure structure, Locale locale);
099    
100            public boolean isShowAddStructureButton(
101                    PermissionChecker permissionChecker, long groupId);
102    
103            public boolean isShowStructureSelector();
104    
105    }