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