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 java.lang.String getPopMessageListenerClass();
155
156 public void setPopMessageListenerClass(
157 java.lang.String popMessageListenerClass);
158
159 public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
160
161 public java.lang.String getSocialActivityInterpreterClass();
162
163 public void setSocialActivityInterpreterClass(
164 java.lang.String socialActivityInterpreterClass);
165
166 public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
167
168 public java.lang.String getSocialRequestInterpreterClass();
169
170 public void setSocialRequestInterpreterClass(
171 java.lang.String socialRequestInterpreterClass);
172
173 public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
174
175 public java.lang.String getWebDAVStorageToken();
176
177 public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
178
179 public java.lang.String getWebDAVStorageClass();
180
181 public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
182
183 public com.liferay.portal.webdav.WebDAVStorage getWebDAVStorageInstance();
184
185 public java.lang.String getControlPanelEntryCategory();
186
187 public void setControlPanelEntryCategory(
188 java.lang.String controlPanelEntryCategory);
189
190 public double getControlPanelEntryWeight();
191
192 public void setControlPanelEntryWeight(double controlPanelEntryWeight);
193
194 public java.lang.String getControlPanelEntryClass();
195
196 public void setControlPanelEntryClass(
197 java.lang.String controlPanelEntryClass);
198
199 public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
200
201 public java.lang.String getDefaultPreferences();
202
203 public void setDefaultPreferences(java.lang.String defaultPreferences);
204
205 public java.lang.String getPreferencesValidator();
206
207 public void setPreferencesValidator(java.lang.String preferencesValidator);
208
209 public boolean getPreferencesCompanyWide();
210
211 public boolean isPreferencesCompanyWide();
212
213 public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
214
215 public boolean getPreferencesUniquePerLayout();
216
217 public boolean isPreferencesUniquePerLayout();
218
219 public void setPreferencesUniquePerLayout(
220 boolean preferencesUniquePerLayout);
221
222 public boolean getPreferencesOwnedByGroup();
223
224 public boolean isPreferencesOwnedByGroup();
225
226 public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
227
228 public boolean getUseDefaultTemplate();
229
230 public boolean isUseDefaultTemplate();
231
232 public void setUseDefaultTemplate(boolean useDefaultTemplate);
233
234 public boolean getShowPortletAccessDenied();
235
236 public boolean isShowPortletAccessDenied();
237
238 public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
239
240 public boolean getShowPortletInactive();
241
242 public boolean isShowPortletInactive();
243
244 public void setShowPortletInactive(boolean showPortletInactive);
245
246 public boolean getActionURLRedirect();
247
248 public boolean isActionURLRedirect();
249
250 public void setActionURLRedirect(boolean actionURLRedirect);
251
252 public boolean getRestoreCurrentView();
253
254 public boolean isRestoreCurrentView();
255
256 public void setRestoreCurrentView(boolean restoreCurrentView);
257
258 public boolean getMaximizeEdit();
259
260 public boolean isMaximizeEdit();
261
262 public void setMaximizeEdit(boolean maximizeEdit);
263
264 public boolean getMaximizeHelp();
265
266 public boolean isMaximizeHelp();
267
268 public void setMaximizeHelp(boolean maximizeHelp);
269
270 public boolean getPopUpPrint();
271
272 public boolean isPopUpPrint();
273
274 public void setPopUpPrint(boolean popUpPrint);
275
276 public boolean getLayoutCacheable();
277
278 public boolean isLayoutCacheable();
279
280 public void setLayoutCacheable(boolean layoutCacheable);
281
282 public boolean getInstanceable();
283
284 public boolean isInstanceable();
285
286 public void setInstanceable(boolean instanceable);
287
288 public boolean getScopeable();
289
290 public boolean isScopeable();
291
292 public void setScopeable(boolean scopeable);
293
294 public java.lang.String getUserPrincipalStrategy();
295
296 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
297
298 public boolean getPrivateRequestAttributes();
299
300 public boolean isPrivateRequestAttributes();
301
302 public void setPrivateRequestAttributes(boolean privateRequestAttributes);
303
304 public boolean getPrivateSessionAttributes();
305
306 public boolean isPrivateSessionAttributes();
307
308 public void setPrivateSessionAttributes(boolean privateSessionAttributes);
309
310 public int getRenderWeight();
311
312 public void setRenderWeight(int renderWeight);
313
314 public boolean getAjaxable();
315
316 public boolean isAjaxable();
317
318 public void setAjaxable(boolean ajaxable);
319
320 public java.util.List<String> getHeaderPortalCss();
321
322 public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
323
324 public java.util.List<String> getHeaderPortletCss();
325
326 public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
327
328 public java.util.List<String> getHeaderPortalJavaScript();
329
330 public void setHeaderPortalJavaScript(
331 java.util.List<String> headerPortalJavaScript);
332
333 public java.util.List<String> getHeaderPortletJavaScript();
334
335 public void setHeaderPortletJavaScript(
336 java.util.List<String> headerPortletJavaScript);
337
338 public java.util.List<String> getFooterPortalCss();
339
340 public void setFooterPortalCss(java.util.List<String> footerPortalCss);
341
342 public java.util.List<String> getFooterPortletCss();
343
344 public void setFooterPortletCss(java.util.List<String> footerPortletCss);
345
346 public java.util.List<String> getFooterPortalJavaScript();
347
348 public void setFooterPortalJavaScript(
349 java.util.List<String> footerPortalJavaScript);
350
351 public java.util.List<String> getFooterPortletJavaScript();
352
353 public void setFooterPortletJavaScript(
354 java.util.List<String> footerPortletJavaScript);
355
356 public java.lang.String getCssClassWrapper();
357
358 public void setCssClassWrapper(java.lang.String cssClassWrapper);
359
360 public java.lang.String getFacebookIntegration();
361
362 public void setFacebookIntegration(java.lang.String facebookIntegration);
363
364 public boolean getAddDefaultResource();
365
366 public boolean isAddDefaultResource();
367
368 public void setAddDefaultResource(boolean addDefaultResource);
369
370 public void setRoles(java.lang.String roles);
371
372 public java.lang.String[] getRolesArray();
373
374 public void setRolesArray(java.lang.String[] rolesArray);
375
376 public java.util.Set<String> getUnlinkedRoles();
377
378 public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
379
380 public java.util.Map<String, String> getRoleMappers();
381
382 public void setRoleMappers(java.util.Map<String, String> roleMappers);
383
384 public void linkRoles();
385
386 public boolean hasRoleWithName(java.lang.String roleName);
387
388 public boolean hasAddPortletPermission(long userId);
389
390 public boolean getSystem();
391
392 public boolean isSystem();
393
394 public void setSystem(boolean system);
395
396 public boolean getInclude();
397
398 public boolean isInclude();
399
400 public void setInclude(boolean include);
401
402 public java.util.Map<String, String> getInitParams();
403
404 public void setInitParams(java.util.Map<String, String> initParams);
405
406 public java.lang.Integer getExpCache();
407
408 public void setExpCache(java.lang.Integer expCache);
409
410 public java.util.Map<String, java.util.Set<String>> getPortletModes();
411
412 public void setPortletModes(
413 java.util.Map<String, java.util.Set<String>> portletModes);
414
415 public boolean hasPortletMode(java.lang.String mimeType,
416 javax.portlet.PortletMode portletMode);
417
418 public java.util.Set<String> getAllPortletModes();
419
420 public boolean hasMultipleMimeTypes();
421
422 public java.util.Set<String> getSupportedLocales();
423
424 public void setSupportedLocales(java.util.Set<String> supportedLocales);
425
426 public java.lang.String getResourceBundle();
427
428 public void setResourceBundle(java.lang.String resourceBundle);
429
430 public com.liferay.portal.model.PortletInfo getPortletInfo();
431
432 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
433
434 public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
435
436 public void setPortletFilters(
437 java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
438
439 public void addProcessingEvent(
440 com.liferay.portal.kernel.xml.QName processingEvent);
441
442 public com.liferay.portal.kernel.xml.QName getProcessingEvent(
443 java.lang.String uri, java.lang.String localPart);
444
445 public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
446
447 public void setProcessingEvents(
448 java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
449
450 public void addPublishingEvent(
451 com.liferay.portal.kernel.xml.QName publishingEvent);
452
453 public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
454
455 public void setPublishingEvents(
456 java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
457
458 public void addPublicRenderParameter(
459 com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
460
461 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
462 java.lang.String identifier);
463
464 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
465 java.lang.String uri, java.lang.String localPart);
466
467 public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
468
469 public void setPublicRenderParameters(
470 java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
471
472 public boolean isRemote();
473
474 public void setRemote(boolean remote);
475
476 public java.lang.String getRemoteConsumerId();
477
478 public void setRemoteConsumerId(java.lang.String remoteConsumerId);
479
480 public java.lang.String getRemoteProducerEntityId();
481
482 public void setRemoteProducerEntityId(
483 java.lang.String remoteProducerEntityId);
484
485 public java.lang.String getRemotePortletHandle();
486
487 public void setRemotePortletHandle(java.lang.String remotePortletHandle);
488
489 public java.lang.String getRemotePortletId();
490
491 public void setRemotePortletId(java.lang.String remotePortletId);
492
493 public java.lang.String getContextPath();
494
495 public com.liferay.portal.model.PortletApp getPortletApp();
496
497 public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
498
499 public com.liferay.portal.model.Portlet getClonedInstance(
500 java.lang.String portletId);
501
502 public boolean getStatic();
503
504 public boolean isStatic();
505
506 public void setStatic(boolean staticPortlet);
507
508 public boolean getStaticStart();
509
510 public boolean isStaticStart();
511
512 public void setStaticStart(boolean staticPortletStart);
513
514 public boolean getStaticEnd();
515
516 public boolean isStaticEnd();
517
518 public boolean getUndeployedPortlet();
519
520 public boolean isUndeployedPortlet();
521
522 public void setUndeployedPortlet(boolean undeployedPortlet);
523
524 public java.lang.Object clone();
525
526 public int compareTo(java.lang.Object obj);
527
528 public boolean equals(java.lang.Object obj);
529 }