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