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