1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.model;
24  
25  
26  /**
27   * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface is a model that represents the <code>Portlet</code> table
36   * in the database.
37   * </p>
38   *
39   * <p>
40   * Customize <code>com.liferay.portal.model.impl.PortletImpl</code>
41   * and rerun the ServiceBuilder to generate the new methods.
42   * </p>
43   *
44   * @author Brian Wing Shun Chan
45   *
46   * @see com.liferay.portal.model.PortletModel
47   * @see com.liferay.portal.model.impl.PortletImpl
48   * @see com.liferay.portal.model.impl.PortletModelImpl
49   *
50   */
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 com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
155 
156     public java.lang.String getPollerProcessorClass();
157 
158     public void setPollerProcessorClass(java.lang.String pollerProcessorClass);
159 
160     public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance();
161 
162     public java.lang.String getPopMessageListenerClass();
163 
164     public void setPopMessageListenerClass(
165         java.lang.String popMessageListenerClass);
166 
167     public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
168 
169     public java.lang.String getSocialActivityInterpreterClass();
170 
171     public void setSocialActivityInterpreterClass(
172         java.lang.String socialActivityInterpreterClass);
173 
174     public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
175 
176     public java.lang.String getSocialRequestInterpreterClass();
177 
178     public void setSocialRequestInterpreterClass(
179         java.lang.String socialRequestInterpreterClass);
180 
181     public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
182 
183     public java.lang.String getDefaultPreferences();
184 
185     public void setDefaultPreferences(java.lang.String defaultPreferences);
186 
187     public java.lang.String getPreferencesValidator();
188 
189     public void setPreferencesValidator(java.lang.String prefsValidator);
190 
191     public boolean getPreferencesCompanyWide();
192 
193     public boolean isPreferencesCompanyWide();
194 
195     public void setPreferencesCompanyWide(boolean prefsCompanyWide);
196 
197     public boolean getPreferencesUniquePerLayout();
198 
199     public boolean isPreferencesUniquePerLayout();
200 
201     public void setPreferencesUniquePerLayout(boolean prefsUniquePerLayout);
202 
203     public boolean getPreferencesOwnedByGroup();
204 
205     public boolean isPreferencesOwnedByGroup();
206 
207     public void setPreferencesOwnedByGroup(boolean prefsOwnedByGroup);
208 
209     public boolean getUseDefaultTemplate();
210 
211     public boolean isUseDefaultTemplate();
212 
213     public void setUseDefaultTemplate(boolean useDefaultTemplate);
214 
215     public boolean getShowPortletAccessDenied();
216 
217     public boolean isShowPortletAccessDenied();
218 
219     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
220 
221     public boolean getShowPortletInactive();
222 
223     public boolean isShowPortletInactive();
224 
225     public void setShowPortletInactive(boolean showPortletInactive);
226 
227     public boolean getActionURLRedirect();
228 
229     public boolean isActionURLRedirect();
230 
231     public void setActionURLRedirect(boolean actionURLRedirect);
232 
233     public boolean getRestoreCurrentView();
234 
235     public boolean isRestoreCurrentView();
236 
237     public void setRestoreCurrentView(boolean restoreCurrentView);
238 
239     public boolean getMaximizeEdit();
240 
241     public boolean isMaximizeEdit();
242 
243     public void setMaximizeEdit(boolean maximizeEdit);
244 
245     public boolean getMaximizeHelp();
246 
247     public boolean isMaximizeHelp();
248 
249     public void setMaximizeHelp(boolean maximizeHelp);
250 
251     public boolean getPopUpPrint();
252 
253     public boolean isPopUpPrint();
254 
255     public void setPopUpPrint(boolean popUpPrint);
256 
257     public boolean getLayoutCacheable();
258 
259     public boolean isLayoutCacheable();
260 
261     public void setLayoutCacheable(boolean layoutCacheable);
262 
263     public boolean getInstanceable();
264 
265     public boolean isInstanceable();
266 
267     public void setInstanceable(boolean instanceable);
268 
269     public java.lang.String getUserPrincipalStrategy();
270 
271     public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
272 
273     public boolean getPrivateRequestAttributes();
274 
275     public boolean isPrivateRequestAttributes();
276 
277     public void setPrivateRequestAttributes(boolean privateRequestAttributes);
278 
279     public boolean getPrivateSessionAttributes();
280 
281     public boolean isPrivateSessionAttributes();
282 
283     public void setPrivateSessionAttributes(boolean privateSessionAttributes);
284 
285     public int getRenderWeight();
286 
287     public void setRenderWeight(int renderWeight);
288 
289     public boolean getAjaxable();
290 
291     public boolean isAjaxable();
292 
293     public void setAjaxable(boolean ajaxable);
294 
295     public java.util.List<String> getHeaderPortalCss();
296 
297     public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
298 
299     public java.util.List<String> getHeaderPortletCss();
300 
301     public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
302 
303     public java.util.List<String> getHeaderPortalJavaScript();
304 
305     public void setHeaderPortalJavaScript(
306         java.util.List<String> headerPortalJavaScript);
307 
308     public java.util.List<String> getHeaderPortletJavaScript();
309 
310     public void setHeaderPortletJavaScript(
311         java.util.List<String> headerPortletJavaScript);
312 
313     public java.util.List<String> getFooterPortalCss();
314 
315     public void setFooterPortalCss(java.util.List<String> footerPortalCss);
316 
317     public java.util.List<String> getFooterPortletCss();
318 
319     public void setFooterPortletCss(java.util.List<String> footerPortletCss);
320 
321     public java.util.List<String> getFooterPortalJavaScript();
322 
323     public void setFooterPortalJavaScript(
324         java.util.List<String> footerPortalJavaScript);
325 
326     public java.util.List<String> getFooterPortletJavaScript();
327 
328     public void setFooterPortletJavaScript(
329         java.util.List<String> footerPortletJavaScript);
330 
331     public java.lang.String getCssClassWrapper();
332 
333     public void setCssClassWrapper(java.lang.String cssClassWrapper);
334 
335     public java.lang.String getFacebookIntegration();
336 
337     public void setFacebookIntegration(java.lang.String facebookIntegration);
338 
339     public boolean getAddDefaultResource();
340 
341     public boolean isAddDefaultResource();
342 
343     public void setAddDefaultResource(boolean addDefaultResource);
344 
345     public void setRoles(java.lang.String roles);
346 
347     public java.lang.String[] getRolesArray();
348 
349     public void setRolesArray(java.lang.String[] rolesArray);
350 
351     public java.util.Set<String> getUnlinkedRoles();
352 
353     public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
354 
355     public java.util.Map<String, String> getRoleMappers();
356 
357     public void setRoleMappers(java.util.Map<String, String> roleMappers);
358 
359     public void linkRoles();
360 
361     public boolean hasRoleWithName(java.lang.String roleName);
362 
363     public boolean hasAddPortletPermission(long userId);
364 
365     public boolean getSystem();
366 
367     public boolean isSystem();
368 
369     public void setSystem(boolean system);
370 
371     public boolean getInclude();
372 
373     public boolean isInclude();
374 
375     public void setInclude(boolean include);
376 
377     public java.util.Map<String, String> getInitParams();
378 
379     public void setInitParams(java.util.Map<String, String> initParams);
380 
381     public java.lang.Integer getExpCache();
382 
383     public void setExpCache(java.lang.Integer expCache);
384 
385     public java.util.Map<String, java.util.Set<String>> getPortletModes();
386 
387     public void setPortletModes(
388         java.util.Map<String, java.util.Set<String>> portletModes);
389 
390     public boolean hasPortletMode(java.lang.String mimeType,
391         javax.portlet.PortletMode portletMode);
392 
393     public java.util.Set<String> getAllPortletModes();
394 
395     public boolean hasMultipleMimeTypes();
396 
397     public java.util.Set<String> getSupportedLocales();
398 
399     public void setSupportedLocales(java.util.Set<String> supportedLocales);
400 
401     public java.lang.String getResourceBundle();
402 
403     public void setResourceBundle(java.lang.String resourceBundle);
404 
405     public com.liferay.portal.model.PortletInfo getPortletInfo();
406 
407     public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
408 
409     public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
410 
411     public void setPortletFilters(
412         java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
413 
414     public void addProcessingEvent(javax.xml.namespace.QName processingEvent);
415 
416     public javax.xml.namespace.QName getProcessingEvent(java.lang.String uri,
417         java.lang.String localPart);
418 
419     public java.util.Set<javax.xml.namespace.QName> getProcessingEvents();
420 
421     public void setProcessingEvents(
422         java.util.Set<javax.xml.namespace.QName> processingEvents);
423 
424     public void addPublishingEvent(javax.xml.namespace.QName publishingEvent);
425 
426     public java.util.Set<javax.xml.namespace.QName> getPublishingEvents();
427 
428     public void setPublishingEvents(
429         java.util.Set<javax.xml.namespace.QName> publishingEvents);
430 
431     public void addPublicRenderParameter(
432         com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
433 
434     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
435         java.lang.String identifier);
436 
437     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
438         java.lang.String uri, java.lang.String localPart);
439 
440     public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
441 
442     public void setPublicRenderParameters(
443         java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
444 
445     public java.lang.String getContextPath();
446 
447     public com.liferay.portal.model.PortletApp getPortletApp();
448 
449     public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
450 
451     public com.liferay.portal.model.Portlet getClonedInstance(
452         java.lang.String portletId);
453 
454     public boolean getStatic();
455 
456     public boolean isStatic();
457 
458     public void setStatic(boolean staticPortlet);
459 
460     public boolean getStaticStart();
461 
462     public boolean isStaticStart();
463 
464     public void setStaticStart(boolean staticPortletStart);
465 
466     public boolean getStaticEnd();
467 
468     public boolean isStaticEnd();
469 
470     public java.lang.Object clone();
471 
472     public int compareTo(com.liferay.portal.model.Portlet portlet);
473 
474     public boolean equals(java.lang.Object obj);
475 }