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 java.lang.String getIcon();
71
72 public void setIcon(java.lang.String icon);
73
74 public java.lang.String getVirtualPath();
75
76 public void setVirtualPath(java.lang.String virtualPath);
77
78 public java.lang.String getStrutsPath();
79
80 public void setStrutsPath(java.lang.String strutsPath);
81
82 public java.lang.String getDisplayName();
83
84 public void setDisplayName(java.lang.String displayName);
85
86 public java.lang.String getPortletClass();
87
88 public void setPortletClass(java.lang.String portletClass);
89
90 public java.lang.String getConfigurationActionClass();
91
92 public void setConfigurationActionClass(
93 java.lang.String configurationActionClass);
94
95 public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
96
97 public java.lang.String getIndexerClass();
98
99 public void setIndexerClass(java.lang.String indexerClass);
100
101 public java.lang.String getOpenSearchClass();
102
103 public void setOpenSearchClass(java.lang.String openSearchClass);
104
105 public java.lang.String getSchedulerClass();
106
107 public void setSchedulerClass(java.lang.String schedulerClass);
108
109 public java.lang.String getPortletURLClass();
110
111 public void setPortletURLClass(java.lang.String portletURLClass);
112
113 public java.lang.String getFriendlyURLMapperClass();
114
115 public void setFriendlyURLMapperClass(
116 java.lang.String friendlyURLMapperClass);
117
118 public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
119
120 public java.lang.String getURLEncoderClass();
121
122 public void setURLEncoderClass(java.lang.String urlEncoderClass);
123
124 public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
125
126 public java.lang.String getPortletDataHandlerClass();
127
128 public void setPortletDataHandlerClass(
129 java.lang.String portletDataHandlerClass);
130
131 public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance();
132
133 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListener();
134
135 public java.lang.String getPortletLayoutListenerClass();
136
137 public void setPortletLayoutListenerClass(
138 java.lang.String portletLayoutListenerClass);
139
140 public java.lang.String getActivityTrackerInterpreterClass();
141
142 public void setActivityTrackerInterpreterClass(
143 java.lang.String activityTrackerInterpreterClass);
144
145 public com.liferay.portal.model.ActivityTrackerInterpreter getActivityTrackerInterpreterInstance();
146
147 public java.lang.String getPopMessageListenerClass();
148
149 public void setPopMessageListenerClass(
150 java.lang.String popMessageListenerClass);
151
152 public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
153
154 public java.lang.String getDefaultPreferences();
155
156 public void setDefaultPreferences(java.lang.String defaultPreferences);
157
158 public java.lang.String getPreferencesValidator();
159
160 public void setPreferencesValidator(java.lang.String prefsValidator);
161
162 public boolean getPreferencesCompanyWide();
163
164 public boolean isPreferencesCompanyWide();
165
166 public void setPreferencesCompanyWide(boolean prefsCompanyWide);
167
168 public boolean getPreferencesUniquePerLayout();
169
170 public boolean isPreferencesUniquePerLayout();
171
172 public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout);
173
174 public boolean getPreferencesOwnedByGroup();
175
176 public boolean isPreferencesOwnedByGroup();
177
178 public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
179
180 public boolean getUseDefaultTemplate();
181
182 public boolean isUseDefaultTemplate();
183
184 public void setUseDefaultTemplate(boolean useDefaultTemplate);
185
186 public boolean getShowPortletAccessDenied();
187
188 public boolean isShowPortletAccessDenied();
189
190 public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
191
192 public boolean getShowPortletInactive();
193
194 public boolean isShowPortletInactive();
195
196 public void setShowPortletInactive(boolean showPortletInactive);
197
198 public boolean getActionURLRedirect();
199
200 public boolean isActionURLRedirect();
201
202 public void setActionURLRedirect(boolean actionURLRedirect);
203
204 public boolean getRestoreCurrentView();
205
206 public boolean isRestoreCurrentView();
207
208 public void setRestoreCurrentView(boolean restoreCurrentView);
209
210 public boolean getMaximizeEdit();
211
212 public boolean isMaximizeEdit();
213
214 public void setMaximizeEdit(boolean maximizeEdit);
215
216 public boolean getMaximizeHelp();
217
218 public boolean isMaximizeHelp();
219
220 public void setMaximizeHelp(boolean maximizeHelp);
221
222 public boolean getPopUpPrint();
223
224 public boolean isPopUpPrint();
225
226 public void setPopUpPrint(boolean popUpPrint);
227
228 public boolean getLayoutCacheable();
229
230 public boolean isLayoutCacheable();
231
232 public void setLayoutCacheable(boolean layoutCacheable);
233
234 public boolean getInstanceable();
235
236 public boolean isInstanceable();
237
238 public void setInstanceable(boolean instanceable);
239
240 public java.lang.String getUserPrincipalStrategy();
241
242 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
243
244 public boolean getPrivateRequestAttributes();
245
246 public boolean isPrivateRequestAttributes();
247
248 public void setPrivateRequestAttributes(boolean privateRequestAttributes);
249
250 public boolean getPrivateSessionAttributes();
251
252 public boolean isPrivateSessionAttributes();
253
254 public void setPrivateSessionAttributes(boolean privateSessionAttributes);
255
256 public int getRenderWeight();
257
258 public void setRenderWeight(int renderWeight);
259
260 public boolean getAjaxable();
261
262 public boolean isAjaxable();
263
264 public void setAjaxable(boolean ajaxable);
265
266 public java.util.List getHeaderPortalCss();
267
268 public void setHeaderPortalCss(java.util.List headerPortalCss);
269
270 public java.util.List getHeaderPortletCss();
271
272 public void setHeaderPortletCss(java.util.List headerPortletCss);
273
274 public java.util.List getHeaderPortalJavaScript();
275
276 public void setHeaderPortalJavaScript(java.util.List headerPortalJavaScript);
277
278 public java.util.List getHeaderPortletJavaScript();
279
280 public void setHeaderPortletJavaScript(
281 java.util.List headerPortletJavaScript);
282
283 public java.util.List getFooterPortalCss();
284
285 public void setFooterPortalCss(java.util.List footerPortalCss);
286
287 public java.util.List getFooterPortletCss();
288
289 public void setFooterPortletCss(java.util.List footerPortletCss);
290
291 public java.util.List getFooterPortalJavaScript();
292
293 public void setFooterPortalJavaScript(java.util.List footerPortalJavaScript);
294
295 public java.util.List getFooterPortletJavaScript();
296
297 public void setFooterPortletJavaScript(
298 java.util.List footerPortletJavaScript);
299
300 public java.lang.String getCssClassWrapper();
301
302 public void setCssClassWrapper(java.lang.String cssClassWrapper);
303
304 public boolean getAddDefaultResource();
305
306 public boolean isAddDefaultResource();
307
308 public void setAddDefaultResource(boolean addDefaultResource);
309
310 public void setRoles(java.lang.String roles);
311
312 public java.lang.String[] getRolesArray();
313
314 public void setRolesArray(java.lang.String[] rolesArray);
315
316 public java.util.Set getUnlinkedRoles();
317
318 public void setUnlinkedRoles(java.util.Set unlinkedRoles);
319
320 public java.util.Map getRoleMappers();
321
322 public void setRoleMappers(java.util.Map roleMappers);
323
324 public void linkRoles();
325
326 public boolean hasRoleWithName(java.lang.String roleName);
327
328 public boolean hasAddPortletPermission(long userId);
329
330 public boolean getSystem();
331
332 public boolean isSystem();
333
334 public void setSystem(boolean system);
335
336 public boolean getInclude();
337
338 public boolean isInclude();
339
340 public void setInclude(boolean include);
341
342 public java.util.Map getInitParams();
343
344 public void setInitParams(java.util.Map initParams);
345
346 public java.lang.Integer getExpCache();
347
348 public void setExpCache(java.lang.Integer expCache);
349
350 public java.util.Map getPortletModes();
351
352 public void setPortletModes(java.util.Map portletModes);
353
354 public boolean hasPortletMode(java.lang.String mimeType,
355 javax.portlet.PortletMode portletMode);
356
357 public java.util.Set getAllPortletModes();
358
359 public boolean hasMultipleMimeTypes();
360
361 public java.util.Set getSupportedLocales();
362
363 public void setSupportedLocales(java.util.Set supportedLocales);
364
365 public java.lang.String getResourceBundle();
366
367 public void setResourceBundle(java.lang.String resourceBundle);
368
369 public com.liferay.portal.model.PortletInfo getPortletInfo();
370
371 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
372
373 public java.util.Set getUserAttributes();
374
375 public void setUserAttributes(java.util.Set userAttributes);
376
377 public java.util.Map getCustomUserAttributes();
378
379 public void setCustomUserAttributes(java.util.Map customUserAttributes);
380
381 public java.lang.String getServletContextName();
382
383 public void setServletContextName(java.lang.String servletContextName);
384
385 public boolean getWARFile();
386
387 public boolean isWARFile();
388
389 public void setWARFile(boolean warFile);
390
391 public java.lang.String getContextPath();
392
393 public com.liferay.portal.model.Portlet getClonedInstance(
394 java.lang.String portletId);
395
396 public boolean getStatic();
397
398 public boolean isStatic();
399
400 public void setStatic(boolean staticPortlet);
401
402 public boolean getStaticStart();
403
404 public boolean isStaticStart();
405
406 public void setStaticStart(boolean staticPortletStart);
407
408 public boolean getStaticEnd();
409
410 public boolean isStaticEnd();
411
412 public java.util.List getServletURLPatterns();
413
414 public void setServletURLPatterns(java.util.List servletURLPatterns);
415
416 public java.lang.Object clone();
417
418 public int compareTo(java.lang.Object obj);
419
420 public boolean equals(java.lang.Object obj);
421 }