1
22
23 package com.liferay.portal.model;
24
25
26
51 public interface Portlet extends PortletModel {
52 public java.lang.String getRootPortletId();
53
54 public java.lang.String getInstanceId();
55
56 public java.lang.String getPluginId();
57
58 public java.lang.String getPluginType();
59
60 public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
61
62 public void setPluginPackage(
63 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
64
65 public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
66
67 public void setDefaultPluginSetting(
68 com.liferay.portal.model.PluginSetting pluginSetting);
69
70 public long getTimestamp();
71
72 public void setTimestamp(long timestamp);
73
74 public java.lang.String getIcon();
75
76 public void setIcon(java.lang.String icon);
77
78 public java.lang.String getVirtualPath();
79
80 public void setVirtualPath(java.lang.String virtualPath);
81
82 public java.lang.String getStrutsPath();
83
84 public void setStrutsPath(java.lang.String strutsPath);
85
86 public java.lang.String getPortletName();
87
88 public void setPortletName(java.lang.String portletName);
89
90 public java.lang.String getDisplayName();
91
92 public void setDisplayName(java.lang.String displayName);
93
94 public java.lang.String getPortletClass();
95
96 public void setPortletClass(java.lang.String portletClass);
97
98 public java.lang.String getConfigurationActionClass();
99
100 public void setConfigurationActionClass(
101 java.lang.String configurationActionClass);
102
103 public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
104
105 public java.lang.String getIndexerClass();
106
107 public void setIndexerClass(java.lang.String indexerClass);
108
109 public com.liferay.portal.kernel.search.Indexer getIndexerInstance();
110
111 public java.lang.String getOpenSearchClass();
112
113 public void setOpenSearchClass(java.lang.String openSearchClass);
114
115 public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance();
116
117 public java.lang.String getSchedulerClass();
118
119 public void setSchedulerClass(java.lang.String schedulerClass);
120
121 public com.liferay.portal.kernel.job.Scheduler getSchedulerInstance();
122
123 public java.lang.String getPortletURLClass();
124
125 public void setPortletURLClass(java.lang.String portletURLClass);
126
127 public java.lang.String getFriendlyURLMapperClass();
128
129 public void setFriendlyURLMapperClass(
130 java.lang.String friendlyURLMapperClass);
131
132 public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
133
134 public java.lang.String getURLEncoderClass();
135
136 public void setURLEncoderClass(java.lang.String urlEncoderClass);
137
138 public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
139
140 public java.lang.String getPortletDataHandlerClass();
141
142 public void setPortletDataHandlerClass(
143 java.lang.String portletDataHandlerClass);
144
145 public com.liferay.portal.lar.PortletDataHandler getPortletDataHandlerInstance();
146
147 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
148
149 public java.lang.String getPortletLayoutListenerClass();
150
151 public void setPortletLayoutListenerClass(
152 java.lang.String portletLayoutListenerClass);
153
154 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
155
156 public java.lang.String getPollerProcessorClass();
157
158 public void setPollerProcessorClass(java.lang.String pollerProcessorClass);
159
160 public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance();
161
162 public java.lang.String getPopMessageListenerClass();
163
164 public void setPopMessageListenerClass(
165 java.lang.String popMessageListenerClass);
166
167 public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
168
169 public java.lang.String getSocialActivityInterpreterClass();
170
171 public void setSocialActivityInterpreterClass(
172 java.lang.String socialActivityInterpreterClass);
173
174 public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
175
176 public java.lang.String getSocialRequestInterpreterClass();
177
178 public void setSocialRequestInterpreterClass(
179 java.lang.String socialRequestInterpreterClass);
180
181 public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
182
183 public java.lang.String getWebDAVStorageToken();
184
185 public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
186
187 public java.lang.String getWebDAVStorageClass();
188
189 public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
190
191 public com.liferay.portal.webdav.WebDAVStorage getWebDAVStorageInstance();
192
193 public java.lang.String getControlPanelEntryCategory();
194
195 public void setControlPanelEntryCategory(
196 java.lang.String controlPanelEntryCategory);
197
198 public double getControlPanelEntryWeight();
199
200 public void setControlPanelEntryWeight(double controlPanelEntryWeight);
201
202 public java.lang.String getControlPanelEntryClass();
203
204 public void setControlPanelEntryClass(
205 java.lang.String controlPanelEntryClass);
206
207 public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
208
209 public java.lang.String getDefaultPreferences();
210
211 public void setDefaultPreferences(java.lang.String defaultPreferences);
212
213 public java.lang.String getPreferencesValidator();
214
215 public void setPreferencesValidator(java.lang.String preferencesValidator);
216
217 public boolean getPreferencesCompanyWide();
218
219 public boolean isPreferencesCompanyWide();
220
221 public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
222
223 public boolean getPreferencesUniquePerLayout();
224
225 public boolean isPreferencesUniquePerLayout();
226
227 public void setPreferencesUniquePerLayout(
228 boolean preferencesUniquePerLayout);
229
230 public boolean getPreferencesOwnedByGroup();
231
232 public boolean isPreferencesOwnedByGroup();
233
234 public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
235
236 public boolean getUseDefaultTemplate();
237
238 public boolean isUseDefaultTemplate();
239
240 public void setUseDefaultTemplate(boolean useDefaultTemplate);
241
242 public boolean getShowPortletAccessDenied();
243
244 public boolean isShowPortletAccessDenied();
245
246 public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
247
248 public boolean getShowPortletInactive();
249
250 public boolean isShowPortletInactive();
251
252 public void setShowPortletInactive(boolean showPortletInactive);
253
254 public boolean getActionURLRedirect();
255
256 public boolean isActionURLRedirect();
257
258 public void setActionURLRedirect(boolean actionURLRedirect);
259
260 public boolean getRestoreCurrentView();
261
262 public boolean isRestoreCurrentView();
263
264 public void setRestoreCurrentView(boolean restoreCurrentView);
265
266 public boolean getMaximizeEdit();
267
268 public boolean isMaximizeEdit();
269
270 public void setMaximizeEdit(boolean maximizeEdit);
271
272 public boolean getMaximizeHelp();
273
274 public boolean isMaximizeHelp();
275
276 public void setMaximizeHelp(boolean maximizeHelp);
277
278 public boolean getPopUpPrint();
279
280 public boolean isPopUpPrint();
281
282 public void setPopUpPrint(boolean popUpPrint);
283
284 public boolean getLayoutCacheable();
285
286 public boolean isLayoutCacheable();
287
288 public void setLayoutCacheable(boolean layoutCacheable);
289
290 public boolean getInstanceable();
291
292 public boolean isInstanceable();
293
294 public void setInstanceable(boolean instanceable);
295
296 public boolean getScopeable();
297
298 public boolean isScopeable();
299
300 public void setScopeable(boolean scopeable);
301
302 public java.lang.String getUserPrincipalStrategy();
303
304 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
305
306 public boolean getPrivateRequestAttributes();
307
308 public boolean isPrivateRequestAttributes();
309
310 public void setPrivateRequestAttributes(boolean privateRequestAttributes);
311
312 public boolean getPrivateSessionAttributes();
313
314 public boolean isPrivateSessionAttributes();
315
316 public void setPrivateSessionAttributes(boolean privateSessionAttributes);
317
318 public int getRenderWeight();
319
320 public void setRenderWeight(int renderWeight);
321
322 public boolean getAjaxable();
323
324 public boolean isAjaxable();
325
326 public void setAjaxable(boolean ajaxable);
327
328 public java.util.List<String> getHeaderPortalCss();
329
330 public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
331
332 public java.util.List<String> getHeaderPortletCss();
333
334 public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
335
336 public java.util.List<String> getHeaderPortalJavaScript();
337
338 public void setHeaderPortalJavaScript(
339 java.util.List<String> headerPortalJavaScript);
340
341 public java.util.List<String> getHeaderPortletJavaScript();
342
343 public void setHeaderPortletJavaScript(
344 java.util.List<String> headerPortletJavaScript);
345
346 public java.util.List<String> getFooterPortalCss();
347
348 public void setFooterPortalCss(java.util.List<String> footerPortalCss);
349
350 public java.util.List<String> getFooterPortletCss();
351
352 public void setFooterPortletCss(java.util.List<String> footerPortletCss);
353
354 public java.util.List<String> getFooterPortalJavaScript();
355
356 public void setFooterPortalJavaScript(
357 java.util.List<String> footerPortalJavaScript);
358
359 public java.util.List<String> getFooterPortletJavaScript();
360
361 public void setFooterPortletJavaScript(
362 java.util.List<String> footerPortletJavaScript);
363
364 public java.lang.String getCssClassWrapper();
365
366 public void setCssClassWrapper(java.lang.String cssClassWrapper);
367
368 public java.lang.String getFacebookIntegration();
369
370 public void setFacebookIntegration(java.lang.String facebookIntegration);
371
372 public boolean getAddDefaultResource();
373
374 public boolean isAddDefaultResource();
375
376 public void setAddDefaultResource(boolean addDefaultResource);
377
378 public void setRoles(java.lang.String roles);
379
380 public java.lang.String[] getRolesArray();
381
382 public void setRolesArray(java.lang.String[] rolesArray);
383
384 public java.util.Set<String> getUnlinkedRoles();
385
386 public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
387
388 public java.util.Map<String, String> getRoleMappers();
389
390 public void setRoleMappers(java.util.Map<String, String> roleMappers);
391
392 public void linkRoles();
393
394 public boolean hasRoleWithName(java.lang.String roleName);
395
396 public boolean hasAddPortletPermission(long userId);
397
398 public boolean getSystem();
399
400 public boolean isSystem();
401
402 public void setSystem(boolean system);
403
404 public boolean getInclude();
405
406 public boolean isInclude();
407
408 public void setInclude(boolean include);
409
410 public java.util.Map<String, String> getInitParams();
411
412 public void setInitParams(java.util.Map<String, String> initParams);
413
414 public java.lang.Integer getExpCache();
415
416 public void setExpCache(java.lang.Integer expCache);
417
418 public java.util.Map<String, java.util.Set<String>> getPortletModes();
419
420 public void setPortletModes(
421 java.util.Map<String, java.util.Set<String>> portletModes);
422
423 public boolean hasPortletMode(java.lang.String mimeType,
424 javax.portlet.PortletMode portletMode);
425
426 public java.util.Set<String> getAllPortletModes();
427
428 public boolean hasMultipleMimeTypes();
429
430 public java.util.Map<String, java.util.Set<String>> getWindowStates();
431
432 public void setWindowStates(
433 java.util.Map<String, java.util.Set<String>> windowStates);
434
435 public boolean hasWindowState(java.lang.String mimeType,
436 javax.portlet.WindowState windowState);
437
438 public java.util.Set<String> getAllWindowStates();
439
440 public java.util.Set<String> getSupportedLocales();
441
442 public void setSupportedLocales(java.util.Set<String> supportedLocales);
443
444 public java.lang.String getResourceBundle();
445
446 public void setResourceBundle(java.lang.String resourceBundle);
447
448 public com.liferay.portal.model.PortletInfo getPortletInfo();
449
450 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
451
452 public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
453
454 public void setPortletFilters(
455 java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
456
457 public void addProcessingEvent(
458 com.liferay.portal.kernel.xml.QName processingEvent);
459
460 public com.liferay.portal.kernel.xml.QName getProcessingEvent(
461 java.lang.String uri, java.lang.String localPart);
462
463 public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
464
465 public void setProcessingEvents(
466 java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
467
468 public void addPublishingEvent(
469 com.liferay.portal.kernel.xml.QName publishingEvent);
470
471 public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
472
473 public void setPublishingEvents(
474 java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
475
476 public void addPublicRenderParameter(
477 com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
478
479 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
480 java.lang.String identifier);
481
482 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
483 java.lang.String uri, java.lang.String localPart);
484
485 public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
486
487 public void setPublicRenderParameters(
488 java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
489
490 public java.lang.String getContextPath();
491
492 public com.liferay.portal.model.PortletApp getPortletApp();
493
494 public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
495
496 public com.liferay.portal.model.Portlet getClonedInstance(
497 java.lang.String portletId);
498
499 public boolean getStatic();
500
501 public boolean isStatic();
502
503 public void setStatic(boolean staticPortlet);
504
505 public boolean getStaticStart();
506
507 public boolean isStaticStart();
508
509 public void setStaticStart(boolean staticPortletStart);
510
511 public boolean getStaticEnd();
512
513 public boolean isStaticEnd();
514
515 public boolean getUndeployedPortlet();
516
517 public boolean isUndeployedPortlet();
518
519 public void setUndeployedPortlet(boolean undeployedPortlet);
520
521 public java.lang.Object clone();
522
523 public int compareTo(com.liferay.portal.model.Portlet portlet);
524
525 public boolean equals(java.lang.Object obj);
526 }