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