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