1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.model;
16  
17  import com.liferay.portal.kernel.exception.PortalException;
18  import com.liferay.portal.kernel.exception.SystemException;
19  
20  import java.util.List;
21  
22  /**
23   * <a href="LayoutTypePortlet.java.html"><b><i>View Source</i></b></a>
24   *
25   * @author Brian Wing Shun Chan
26   */
27  public interface LayoutTypePortlet extends LayoutType {
28  
29      public void addModeAboutPortletId(String portletId);
30  
31      public void addModeConfigPortletId(String portletId);
32  
33      public void addModeEditDefaultsPortletId(String portletId);
34  
35      public void addModeEditGuestPortletId(String portletId);
36  
37      public void addModeEditPortletId(String portletId);
38  
39      public void addModeHelpPortletId(String portletId);
40  
41      public void addModePreviewPortletId(String portletId);
42  
43      public void addModePrintPortletId(String portletId);
44  
45      public String addPortletId(long userId, String portletId)
46          throws PortalException, SystemException;
47  
48      public String addPortletId(
49              long userId, String portletId, boolean checkPermission)
50          throws PortalException, SystemException;
51  
52      public String addPortletId(
53              long userId, String portletId, String columnId, int columnPos)
54          throws PortalException, SystemException;
55  
56      public String addPortletId(
57              long userId, String portletId, String columnId, int columnPos,
58              boolean checkPermission)
59          throws PortalException, SystemException;
60  
61      public void addPortletIds(
62              long userId, String[] portletIds, boolean checkPermission)
63          throws PortalException, SystemException;
64  
65      public void addPortletIds(
66              long userId, String[] portletIds, String columnId,
67              boolean checkPermission)
68          throws PortalException, SystemException;
69  
70      public void addStateMaxPortletId(String portletId);
71  
72      public void addStateMinPortletId(String portletId);
73  
74      public List<Portlet> addStaticPortlets(
75              List<Portlet> portlets, List<Portlet> startPortlets,
76              List<Portlet> endPortlets)
77          throws SystemException;
78  
79      public List<Portlet> getAllPortlets()
80          throws PortalException, SystemException;
81  
82      public List<Portlet> getAllPortlets(String columnId)
83          throws PortalException, SystemException;
84  
85      public LayoutTemplate getLayoutTemplate();
86  
87      public String getLayoutTemplateId();
88  
89      public String getModeAbout();
90  
91      public String getModeConfig();
92  
93      public String getModeEdit();
94  
95      public String getModeEditDefaults();
96  
97      public String getModeEditGuest();
98  
99      public String getModeHelp();
100 
101     public String getModePreview();
102 
103     public String getModePrint();
104 
105     public int getNumOfColumns();
106 
107     public List<String> getPortletIds();
108 
109     public List<Portlet> getPortlets() throws SystemException;
110 
111     public String getStateMax();
112 
113     public String getStateMaxPortletId();
114 
115     public String getStateMin();
116 
117     public boolean hasDefaultScopePortletId(long groupId, String portletId)
118         throws PortalException, SystemException;
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         throws PortalException, SystemException;
140 
141     public boolean hasStateMax();
142 
143     public boolean hasStateMaxPortletId(String portletId);
144 
145     public boolean hasStateMin();
146 
147     public boolean hasStateMinPortletId(String portletId);
148 
149     public boolean hasStateNormalPortletId(String portletId);
150 
151     public void movePortletId(
152             long userId, String portletId, String columnId, int columnPos)
153         throws PortalException, SystemException;
154 
155     public void removeModeAboutPortletId(String portletId);
156 
157     public void removeModeConfigPortletId(String portletId);
158 
159     public void removeModeEditDefaultsPortletId(String portletId);
160 
161     public void removeModeEditGuestPortletId(String portletId);
162 
163     public void removeModeEditPortletId(String portletId);
164 
165     public void removeModeHelpPortletId(String portletId);
166 
167     public void removeModePreviewPortletId(String portletId);
168 
169     public void removeModePrintPortletId(String portletId);
170 
171     public void removeModesPortletId(String portletId);
172 
173     public void removeNestedColumns(String portletId);
174 
175     public void removePortletId(long userId, String portletId);
176 
177     public void removePortletId(
178         long userId, String portletId, boolean modeAndState);
179 
180     public void removeStateMaxPortletId(String portletId);
181 
182     public void removeStateMinPortletId(String portletId);
183 
184     public void removeStatesPortletId(String portletId);
185 
186     public void reorganizePortlets(
187         List<String> newColumns, List<String> oldColumns);
188 
189     public void resetModes();
190 
191     public void resetStates();
192 
193     public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
194 
195     public void setLayoutTemplateId(
196         long userId, String newLayoutTemplateId, boolean checkPermission);
197 
198     public void setModeAbout(String modeAbout);
199 
200     public void setModeConfig(String modeConfig);
201 
202     public void setModeEdit(String modeEdit);
203 
204     public void setModeEditDefaults(String modeEditDefaults);
205 
206     public void setModeEditGuest(String modeEditGuest);
207 
208     public void setModeHelp(String modeHelp);
209 
210     public void setModePreview(String modePreview);
211 
212     public void setModePrint(String modePrint);
213 
214     public void setPortletIds(String columnId, String portletIds);
215 
216     public void setStateMax(String stateMax);
217 
218     public void setStateMin(String stateMin);
219 
220 }