1
22
23 package com.liferay.portal.model;
24
25
50 public interface Portlet extends PortletModel {
51 public java.lang.String getRootPortletId();
52
53 public java.lang.String getInstanceId();
54
55 public java.lang.String getPluginId();
56
57 public java.lang.String getPluginType();
58
59 public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
60
61 public void setPluginPackage(
62 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
63
64 public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
65
66 public void setDefaultPluginSetting(
67 com.liferay.portal.model.PluginSetting pluginSetting);
68
69 public java.lang.String getIcon();
70
71 public void setIcon(java.lang.String icon);
72
73 public java.lang.String getVirtualPath();
74
75 public void setVirtualPath(java.lang.String virtualPath);
76
77 public java.lang.String getStrutsPath();
78
79 public void setStrutsPath(java.lang.String strutsPath);
80
81 public java.lang.String getDisplayName();
82
83 public void setDisplayName(java.lang.String displayName);
84
85 public java.lang.String getPortletClass();
86
87 public void setPortletClass(java.lang.String portletClass);
88
89 public java.lang.String getConfigurationActionClass();
90
91 public void setConfigurationActionClass(
92 java.lang.String configurationActionClass);
93
94 public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
95
96 public java.lang.String getIndexerClass();
97
98 public void setIndexerClass(java.lang.String indexerClass);
99
100 public java.lang.String getOpenSearchClass();
101
102 public void setOpenSearchClass(java.lang.String openSearchClass);
103
104 public java.lang.String getSchedulerClass();
105
106 public void setSchedulerClass(java.lang.String schedulerClass);
107
108 public java.lang.String getPortletURLClass();
109
110 public void setPortletURLClass(java.lang.String portletURLClass);
111
112 public java.lang.String getFriendlyURLMapperClass();
113
114 public void setFriendlyURLMapperClass(
115 java.lang.String friendlyURLMapperClass);
116
117 public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
118
119 public java.lang.String getURLEncoderClass();
120
121 public void setURLEncoderClass(java.lang.String urlEncoderClass);
122
123 public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
124
125 public java.lang.String getPortletDataHandlerClass();
126
127 public void setPortletDataHandlerClass(
128 java.lang.String portletDataHandlerClass);
129
130 public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance();
131
132 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
133
134 public java.lang.String getPortletLayoutListenerClass();
135
136 public void setPortletLayoutListenerClass(
137 java.lang.String portletLayoutListenerClass);
138
139 public java.lang.String getSmtpMessageListenerClass();
140
141 public void setSmtpMessageListenerClass(
142 java.lang.String smtpMessageListenerClass);
143
144 public com.liferay.portal.kernel.smtp.MessageListener getSmtpMessageListenerInstance();
145
146 public java.lang.String getDefaultPreferences();
147
148 public void setDefaultPreferences(java.lang.String defaultPreferences);
149
150 public java.lang.String getPreferencesValidator();
151
152 public void setPreferencesValidator(java.lang.String prefsValidator);
153
154 public boolean getPreferencesCompanyWide();
155
156 public boolean isPreferencesCompanyWide();
157
158 public void setPreferencesCompanyWide(boolean prefsCompanyWide);
159
160 public boolean getPreferencesUniquePerLayout();
161
162 public boolean isPreferencesUniquePerLayout();
163
164 public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout);
165
166 public boolean getPreferencesOwnedByGroup();
167
168 public boolean isPreferencesOwnedByGroup();
169
170 public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
171
172 public boolean getUseDefaultTemplate();
173
174 public boolean isUseDefaultTemplate();
175
176 public void setUseDefaultTemplate(boolean useDefaultTemplate);
177
178 public boolean getShowPortletAccessDenied();
179
180 public boolean isShowPortletAccessDenied();
181
182 public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
183
184 public boolean getShowPortletInactive();
185
186 public boolean isShowPortletInactive();
187
188 public void setShowPortletInactive(boolean showPortletInactive);
189
190 public boolean getActionURLRedirect();
191
192 public boolean isActionURLRedirect();
193
194 public void setActionURLRedirect(boolean actionURLRedirect);
195
196 public boolean getRestoreCurrentView();
197
198 public boolean isRestoreCurrentView();
199
200 public void setRestoreCurrentView(boolean restoreCurrentView);
201
202 public boolean getMaximizeEdit();
203
204 public boolean isMaximizeEdit();
205
206 public void setMaximizeEdit(boolean maximizeEdit);
207
208 public boolean getMaximizeHelp();
209
210 public boolean isMaximizeHelp();
211
212 public void setMaximizeHelp(boolean maximizeHelp);
213
214 public boolean getPopUpPrint();
215
216 public boolean isPopUpPrint();
217
218 public void setPopUpPrint(boolean popUpPrint);
219
220 public boolean getLayoutCacheable();
221
222 public boolean isLayoutCacheable();
223
224 public void setLayoutCacheable(boolean layoutCacheable);
225
226 public boolean getInstanceable();
227
228 public boolean isInstanceable();
229
230 public void setInstanceable(boolean instanceable);
231
232 public java.lang.String getUserPrincipalStrategy();
233
234 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
235
236 public boolean getPrivateRequestAttributes();
237
238 public boolean isPrivateRequestAttributes();
239
240 public void setPrivateRequestAttributes(boolean privateRequestAttributes);
241
242 public boolean getPrivateSessionAttributes();
243
244 public boolean isPrivateSessionAttributes();
245
246 public void setPrivateSessionAttributes(boolean privateSessionAttributes);
247
248 public int getRenderWeight();
249
250 public void setRenderWeight(int renderWeight);
251
252 public boolean getAjaxable();
253
254 public boolean isAjaxable();
255
256 public void setAjaxable(boolean ajaxable);
257
258 public java.util.List getHeaderPortalCss();
259
260 public void setHeaderPortalCss(java.util.List headerPortalCss);
261
262 public java.util.List getHeaderPortletCss();
263
264 public void setHeaderPortletCss(java.util.List headerPortletCss);
265
266 public java.util.List getHeaderPortalJavaScript();
267
268 public void setHeaderPortalJavaScript(java.util.List headerPortalJavaScript);
269
270 public java.util.List getHeaderPortletJavaScript();
271
272 public void setHeaderPortletJavaScript(
273 java.util.List headerPortletJavaScript);
274
275 public java.util.List getFooterPortalCss();
276
277 public void setFooterPortalCss(java.util.List footerPortalCss);
278
279 public java.util.List getFooterPortletCss();
280
281 public void setFooterPortletCss(java.util.List footerPortletCss);
282
283 public java.util.List getFooterPortalJavaScript();
284
285 public void setFooterPortalJavaScript(java.util.List footerPortalJavaScript);
286
287 public java.util.List getFooterPortletJavaScript();
288
289 public void setFooterPortletJavaScript(
290 java.util.List footerPortletJavaScript);
291
292 public boolean getAddDefaultResource();
293
294 public boolean isAddDefaultResource();
295
296 public void setAddDefaultResource(boolean addDefaultResource);
297
298 public void setRoles(java.lang.String roles);
299
300 public java.lang.String[] getRolesArray();
301
302 public void setRolesArray(java.lang.String[] rolesArray);
303
304 public java.util.Set getUnlinkedRoles();
305
306 public void setUnlinkedRoles(java.util.Set unlinkedRoles);
307
308 public java.util.Map getRoleMappers();
309
310 public void setRoleMappers(java.util.Map roleMappers);
311
312 public void linkRoles();
313
314 public boolean hasRoleWithName(java.lang.String roleName);
315
316 public boolean hasAddPortletPermission(long userId);
317
318 public boolean getSystem();
319
320 public boolean isSystem();
321
322 public void setSystem(boolean system);
323
324 public boolean getInclude();
325
326 public boolean isInclude();
327
328 public void setInclude(boolean include);
329
330 public java.util.Map getInitParams();
331
332 public void setInitParams(java.util.Map initParams);
333
334 public java.lang.Integer getExpCache();
335
336 public void setExpCache(java.lang.Integer expCache);
337
338 public java.util.Map getPortletModes();
339
340 public void setPortletModes(java.util.Map portletModes);
341
342 public boolean hasPortletMode(java.lang.String mimeType,
343 javax.portlet.PortletMode portletMode);
344
345 public java.util.Set getAllPortletModes();
346
347 public boolean hasMultipleMimeTypes();
348
349 public java.util.Set getSupportedLocales();
350
351 public void setSupportedLocales(java.util.Set supportedLocales);
352
353 public java.lang.String getResourceBundle();
354
355 public void setResourceBundle(java.lang.String resourceBundle);
356
357 public com.liferay.portal.model.PortletInfo getPortletInfo();
358
359 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
360
361 public java.util.Set getUserAttributes();
362
363 public void setUserAttributes(java.util.Set userAttributes);
364
365 public java.util.Map getCustomUserAttributes();
366
367 public void setCustomUserAttributes(java.util.Map customUserAttributes);
368
369 public java.lang.String getServletContextName();
370
371 public void setServletContextName(java.lang.String servletContextName);
372
373 public boolean getWARFile();
374
375 public boolean isWARFile();
376
377 public void setWARFile(boolean warFile);
378
379 public java.lang.String getContextPath();
380
381 public com.liferay.portal.model.Portlet getClonedInstance(
382 java.lang.String portletId);
383
384 public boolean getStatic();
385
386 public boolean isStatic();
387
388 public void setStatic(boolean staticPortlet);
389
390 public boolean getStaticStart();
391
392 public boolean isStaticStart();
393
394 public void setStaticStart(boolean staticPortletStart);
395
396 public boolean getStaticEnd();
397
398 public boolean isStaticEnd();
399
400 public java.util.List getServletURLPatterns();
401
402 public void setServletURLPatterns(java.util.List servletURLPatterns);
403
404 public java.lang.Object clone();
405
406 public int compareTo(java.lang.Object obj);
407
408 public boolean equals(java.lang.Object obj);
409 }