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