001
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
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 hasStateMax();
151
152 public boolean hasStateMaxPortletId(String portletId);
153
154 public boolean hasStateMin();
155
156 public boolean hasStateMinPortletId(String portletId);
157
158 public boolean hasStateNormalPortletId(String portletId);
159
160 public boolean hasUpdatePermission();
161
162 public boolean isCacheable() throws PortalException, SystemException;
163
164 public boolean isColumnCustomizable(String columnId);
165
166 public boolean isColumnDisabled(String columnId);
167
168 public boolean isCustomizable();
169
170 public boolean isCustomizedView();
171
172 public boolean isDefaultUpdated();
173
174 public boolean isPortletCustomizable(String portletId);
175
176 public void movePortletId(
177 long userId, String portletId, String columnId, int columnPos)
178 throws PortalException, SystemException;
179
180 public void removeModeAboutPortletId(String portletId);
181
182 public void removeModeConfigPortletId(String portletId);
183
184 public void removeModeEditDefaultsPortletId(String portletId);
185
186 public void removeModeEditGuestPortletId(String portletId);
187
188 public void removeModeEditPortletId(String portletId);
189
190 public void removeModeHelpPortletId(String portletId);
191
192 public void removeModePreviewPortletId(String portletId);
193
194 public void removeModePrintPortletId(String portletId);
195
196 public void removeModesPortletId(String portletId);
197
198 public void removeNestedColumns(String portletNamespace);
199
200 public void removePortletId(long userId, String portletId);
201
202 public void removePortletId(
203 long userId, String portletId, boolean modeAndState);
204
205 public void removeStateMaxPortletId(String portletId);
206
207 public void removeStateMinPortletId(String portletId);
208
209 public void removeStatesPortletId(String portletId);
210
211 public void reorganizePortlets(
212 List<String> newColumns, List<String> oldColumns);
213
214 public void resetModes();
215
216 public void resetStates();
217
218 public void resetUserPreferences();
219
220 public void setCustomizedView(boolean customizedView);
221
222 public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
223
224 public void setLayoutTemplateId(
225 long userId, String newLayoutTemplateId, boolean checkPermission);
226
227 public void setModeAbout(String modeAbout);
228
229 public void setModeConfig(String modeConfig);
230
231 public void setModeEdit(String modeEdit);
232
233 public void setModeEditDefaults(String modeEditDefaults);
234
235 public void setModeEditGuest(String modeEditGuest);
236
237 public void setModeHelp(String modeHelp);
238
239 public void setModePreview(String modePreview);
240
241 public void setModePrint(String modePrint);
242
243 public void setPortalPreferences(PortalPreferences portalPreferences);
244
245 public void setStateMax(String stateMax);
246
247 public void setStateMin(String stateMin);
248
249 public void setUpdatePermission(boolean updatePermission);
250
251 }