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