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.portal.kernel.model;
016    
017    import com.liferay.portal.kernel.portlet.PortalPreferences;
018    import com.liferay.portal.kernel.util.UnicodeProperties;
019    
020    import java.util.List;
021    
022    /**
023     * @author Brian Wing Shun Chan
024     * @author Raymond Augé
025     */
026    public interface LayoutTypePortlet extends LayoutType {
027    
028            public void addModeAboutPortletId(String portletId);
029    
030            public void addModeConfigPortletId(String portletId);
031    
032            public void addModeEditDefaultsPortletId(String portletId);
033    
034            public void addModeEditGuestPortletId(String portletId);
035    
036            public void addModeEditPortletId(String portletId);
037    
038            public void addModeHelpPortletId(String portletId);
039    
040            public void addModePreviewPortletId(String portletId);
041    
042            public void addModePrintPortletId(String portletId);
043    
044            public String addPortletId(long userId, String portletId);
045    
046            public String addPortletId(
047                    long userId, String portletId, boolean checkPermission);
048    
049            public String addPortletId(
050                    long userId, String portletId, String columnId, int columnPos);
051    
052            public String addPortletId(
053                    long userId, String portletId, String columnId, int columnPos,
054                    boolean checkPermission);
055    
056            public void addPortletIds(
057                    long userId, String[] portletIds, boolean checkPermission);
058    
059            public void addPortletIds(
060                    long userId, String[] portletIds, String columnId,
061                    boolean checkPermission);
062    
063            public void addStateMaxPortletId(String portletId);
064    
065            public void addStateMinPortletId(String portletId);
066    
067            public List<Portlet> addStaticPortlets(
068                    List<Portlet> portlets, List<Portlet> startPortlets,
069                    List<Portlet> endPortlets);
070    
071            public List<Portlet> getAllPortlets();
072    
073            public List<Portlet> getAllPortlets(boolean includeSystem);
074    
075            public List<Portlet> getAllPortlets(String columnId);
076    
077            public List<Portlet> getEmbeddedPortlets();
078    
079            public List<Portlet> getExplicitlyAddedPortlets();
080    
081            public Layout getLayoutSetPrototypeLayout();
082    
083            public String getLayoutSetPrototypeLayoutProperty(String key);
084    
085            public LayoutTemplate getLayoutTemplate();
086    
087            public String getLayoutTemplateId();
088    
089            public String getModeAbout();
090    
091            public String getModeConfig();
092    
093            public String getModeEdit();
094    
095            public String getModeEditDefaults();
096    
097            public String getModeEditGuest();
098    
099            public String getModeHelp();
100    
101            public String getModePreview();
102    
103            public String getModePrint();
104    
105            public int getNumOfColumns();
106    
107            public PortalPreferences getPortalPreferences();
108    
109            public List<String> getPortletIds();
110    
111            public List<Portlet> getPortlets();
112    
113            public String getStateMax();
114    
115            public String getStateMaxPortletId();
116    
117            public String getStateMin();
118    
119            public boolean hasDefaultScopePortletId(long groupId, String portletId);
120    
121            public boolean hasModeAboutPortletId(String portletId);
122    
123            public boolean hasModeConfigPortletId(String portletId);
124    
125            public boolean hasModeEditDefaultsPortletId(String portletId);
126    
127            public boolean hasModeEditGuestPortletId(String portletId);
128    
129            public boolean hasModeEditPortletId(String portletId);
130    
131            public boolean hasModeHelpPortletId(String portletId);
132    
133            public boolean hasModePreviewPortletId(String portletId);
134    
135            public boolean hasModePrintPortletId(String portletId);
136    
137            public boolean hasModeViewPortletId(String portletId);
138    
139            public boolean hasPortletId(String portletId);
140    
141            public boolean hasPortletId(String portletId, boolean strict);
142    
143            public boolean hasStateMax();
144    
145            public boolean hasStateMaxPortletId(String portletId);
146    
147            public boolean hasStateMin();
148    
149            public boolean hasStateMinPortletId(String portletId);
150    
151            public boolean hasStateNormalPortletId(String portletId);
152    
153            public boolean hasUpdatePermission();
154    
155            public boolean isCacheable();
156    
157            public boolean isColumnCustomizable(String columnId);
158    
159            public boolean isColumnDisabled(String columnId);
160    
161            public boolean isCustomizable();
162    
163            public boolean isCustomizedView();
164    
165            public boolean isDefaultUpdated();
166    
167            public boolean isPortletCustomizable(String portletId);
168    
169            public boolean isPortletEmbedded(String portletId);
170    
171            public void movePortletId(
172                    long userId, String portletId, String columnId, int columnPos);
173    
174            public void removeCustomization(UnicodeProperties typeSettingsProperties);
175    
176            public void removeModeAboutPortletId(String portletId);
177    
178            public void removeModeConfigPortletId(String portletId);
179    
180            public void removeModeEditDefaultsPortletId(String portletId);
181    
182            public void removeModeEditGuestPortletId(String portletId);
183    
184            public void removeModeEditPortletId(String portletId);
185    
186            public void removeModeHelpPortletId(String portletId);
187    
188            public void removeModePreviewPortletId(String portletId);
189    
190            public void removeModePrintPortletId(String portletId);
191    
192            public void removeModesPortletId(String portletId);
193    
194            public void removeNestedColumns(String portletNamespace);
195    
196            public void removePortletId(long userId, String portletId);
197    
198            public void removePortletId(
199                    long userId, String portletId, boolean modeAndState);
200    
201            public void removeStateMaxPortletId(String portletId);
202    
203            public void removeStateMinPortletId(String portletId);
204    
205            public void removeStatesPortletId(String portletId);
206    
207            public void reorganizePortlets(
208                    List<String> newColumns, List<String> oldColumns);
209    
210            public void resetModes();
211    
212            public void resetStates();
213    
214            public void resetUserPreferences();
215    
216            public void setCustomizedView(boolean customizedView);
217    
218            public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
219    
220            public void setLayoutTemplateId(
221                    long userId, String newLayoutTemplateId, boolean checkPermission);
222    
223            public void setModeAbout(String modeAbout);
224    
225            public void setModeConfig(String modeConfig);
226    
227            public void setModeEdit(String modeEdit);
228    
229            public void setModeEditDefaults(String modeEditDefaults);
230    
231            public void setModeEditGuest(String modeEditGuest);
232    
233            public void setModeHelp(String modeHelp);
234    
235            public void setModePreview(String modePreview);
236    
237            public void setModePrint(String modePrint);
238    
239            public void setPortalPreferences(PortalPreferences portalPreferences);
240    
241            public void setStateMax(String stateMax);
242    
243            public void setStateMin(String stateMin);
244    
245            public void setUpdatePermission(boolean updatePermission);
246    
247    }