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