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