001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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    
020    import java.util.List;
021    
022    /**
023     * @author Brian Wing Shun Chan
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                    throws PortalException, SystemException;
045    
046            public String addPortletId(
047                            long userId, String portletId, boolean checkPermission)
048                    throws PortalException, SystemException;
049    
050            public String addPortletId(
051                            long userId, String portletId, String columnId, int columnPos)
052                    throws PortalException, SystemException;
053    
054            public String addPortletId(
055                            long userId, String portletId, String columnId, int columnPos,
056                            boolean checkPermission)
057                    throws PortalException, SystemException;
058    
059            public void addPortletIds(
060                            long userId, String[] portletIds, boolean checkPermission)
061                    throws PortalException, SystemException;
062    
063            public void addPortletIds(
064                            long userId, String[] portletIds, String columnId,
065                            boolean checkPermission)
066                    throws PortalException, SystemException;
067    
068            public void addStateMaxPortletId(String portletId);
069    
070            public void addStateMinPortletId(String portletId);
071    
072            public List<Portlet> addStaticPortlets(
073                            List<Portlet> portlets, List<Portlet> startPortlets,
074                            List<Portlet> endPortlets)
075                    throws SystemException;
076    
077            public List<Portlet> getAllPortlets()
078                    throws PortalException, SystemException;
079    
080            public List<Portlet> getAllPortlets(String columnId)
081                    throws PortalException, SystemException;
082    
083            public LayoutTemplate getLayoutTemplate();
084    
085            public String getLayoutTemplateId();
086    
087            public String getModeAbout();
088    
089            public String getModeConfig();
090    
091            public String getModeEdit();
092    
093            public String getModeEditDefaults();
094    
095            public String getModeEditGuest();
096    
097            public String getModeHelp();
098    
099            public String getModePreview();
100    
101            public String getModePrint();
102    
103            public int getNumOfColumns();
104    
105            public List<String> getPortletIds();
106    
107            public List<Portlet> getPortlets() throws SystemException;
108    
109            public String getStateMax();
110    
111            public String getStateMaxPortletId();
112    
113            public String getStateMin();
114    
115            public boolean hasDefaultScopePortletId(long groupId, String portletId)
116                    throws PortalException, SystemException;
117    
118            public boolean hasModeAboutPortletId(String portletId);
119    
120            public boolean hasModeConfigPortletId(String portletId);
121    
122            public boolean hasModeEditDefaultsPortletId(String portletId);
123    
124            public boolean hasModeEditGuestPortletId(String portletId);
125    
126            public boolean hasModeEditPortletId(String portletId);
127    
128            public boolean hasModeHelpPortletId(String portletId);
129    
130            public boolean hasModePreviewPortletId(String portletId);
131    
132            public boolean hasModePrintPortletId(String portletId);
133    
134            public boolean hasModeViewPortletId(String portletId);
135    
136            public boolean hasPortletId(String portletId)
137                    throws PortalException, SystemException;
138    
139            public boolean hasStateMax();
140    
141            public boolean hasStateMaxPortletId(String portletId);
142    
143            public boolean hasStateMin();
144    
145            public boolean hasStateMinPortletId(String portletId);
146    
147            public boolean hasStateNormalPortletId(String portletId);
148    
149            public void movePortletId(
150                            long userId, String portletId, String columnId, int columnPos)
151                    throws PortalException, SystemException;
152    
153            public void removeModeAboutPortletId(String portletId);
154    
155            public void removeModeConfigPortletId(String portletId);
156    
157            public void removeModeEditDefaultsPortletId(String portletId);
158    
159            public void removeModeEditGuestPortletId(String portletId);
160    
161            public void removeModeEditPortletId(String portletId);
162    
163            public void removeModeHelpPortletId(String portletId);
164    
165            public void removeModePreviewPortletId(String portletId);
166    
167            public void removeModePrintPortletId(String portletId);
168    
169            public void removeModesPortletId(String portletId);
170    
171            public void removeNestedColumns(String portletId);
172    
173            public void removePortletId(long userId, String portletId);
174    
175            public void removePortletId(
176                    long userId, String portletId, boolean modeAndState);
177    
178            public void removeStateMaxPortletId(String portletId);
179    
180            public void removeStateMinPortletId(String portletId);
181    
182            public void removeStatesPortletId(String portletId);
183    
184            public void reorganizePortlets(
185                    List<String> newColumns, List<String> oldColumns);
186    
187            public void resetModes();
188    
189            public void resetStates();
190    
191            public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
192    
193            public void setLayoutTemplateId(
194                    long userId, String newLayoutTemplateId, boolean checkPermission);
195    
196            public void setModeAbout(String modeAbout);
197    
198            public void setModeConfig(String modeConfig);
199    
200            public void setModeEdit(String modeEdit);
201    
202            public void setModeEditDefaults(String modeEditDefaults);
203    
204            public void setModeEditGuest(String modeEditGuest);
205    
206            public void setModeHelp(String modeHelp);
207    
208            public void setModePreview(String modePreview);
209    
210            public void setModePrint(String modePrint);
211    
212            public void setPortletIds(String columnId, String portletIds);
213    
214            public void setStateMax(String stateMax);
215    
216            public void setStateMin(String stateMin);
217    
218    }