1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.model;
16  
17  
18  /**
19   * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
20   *
21   * <p>
22   * ServiceBuilder generated this class. Modifications in this class will be
23   * overwritten the next time is generated.
24   * </p>
25   *
26   * <p>
27   * This interface is a model that represents the Portlet table in the
28   * database.
29   * </p>
30   *
31   * <p>
32   * Customize {@link com.liferay.portal.model.impl.PortletImpl} and rerun the
33   * ServiceBuilder to generate the new methods.
34   * </p>
35   *
36   * @author    Brian Wing Shun Chan
37   * @see       PortletModel
38   * @see       com.liferay.portal.model.impl.PortletImpl
39   * @see       com.liferay.portal.model.impl.PortletModelImpl
40   * @generated
41   */
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 void addSchedulerEntry(
115         com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry);
116 
117     public java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries();
118 
119     public void setSchedulerEntries(
120         java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries);
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 getXmlRpcMethodClass();
193 
194     public void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass);
195 
196     public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance();
197 
198     public java.lang.String getControlPanelEntryCategory();
199 
200     public void setControlPanelEntryCategory(
201         java.lang.String controlPanelEntryCategory);
202 
203     public double getControlPanelEntryWeight();
204 
205     public void setControlPanelEntryWeight(double controlPanelEntryWeight);
206 
207     public java.lang.String getControlPanelEntryClass();
208 
209     public void setControlPanelEntryClass(
210         java.lang.String controlPanelEntryClass);
211 
212     public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
213 
214     public java.util.List<String> getAssetRendererFactoryClasses();
215 
216     public void setAssetRendererFactoryClasses(
217         java.util.List<String> assetRendererFactoryClasses);
218 
219     public java.util.List<com.liferay.portlet.asset.model.AssetRendererFactory> getAssetRendererFactoryInstances();
220 
221     public java.util.List<String> getCustomAttributesDisplayClasses();
222 
223     public void setCustomAttributesDisplayClasses(
224         java.util.List<String> customAttributesDisplayClasses);
225 
226     public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplayInstances();
227 
228     public java.util.List<String> getWorkflowHandlerClasses();
229 
230     public void setWorkflowHandlerClasses(
231         java.util.List<String> workflowHandlerClasses);
232 
233     public java.util.List<com.liferay.portal.kernel.workflow.WorkflowHandler> getWorkflowHandlerInstances();
234 
235     public java.lang.String getDefaultPreferences();
236 
237     public void setDefaultPreferences(java.lang.String defaultPreferences);
238 
239     public java.lang.String getPreferencesValidator();
240 
241     public void setPreferencesValidator(java.lang.String preferencesValidator);
242 
243     public boolean getPreferencesCompanyWide();
244 
245     public boolean isPreferencesCompanyWide();
246 
247     public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
248 
249     public boolean getPreferencesUniquePerLayout();
250 
251     public boolean isPreferencesUniquePerLayout();
252 
253     public void setPreferencesUniquePerLayout(
254         boolean preferencesUniquePerLayout);
255 
256     public boolean getPreferencesOwnedByGroup();
257 
258     public boolean isPreferencesOwnedByGroup();
259 
260     public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
261 
262     public boolean getUseDefaultTemplate();
263 
264     public boolean isUseDefaultTemplate();
265 
266     public void setUseDefaultTemplate(boolean useDefaultTemplate);
267 
268     public boolean getShowPortletAccessDenied();
269 
270     public boolean isShowPortletAccessDenied();
271 
272     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
273 
274     public boolean getShowPortletInactive();
275 
276     public boolean isShowPortletInactive();
277 
278     public void setShowPortletInactive(boolean showPortletInactive);
279 
280     public boolean getActionURLRedirect();
281 
282     public boolean isActionURLRedirect();
283 
284     public void setActionURLRedirect(boolean actionURLRedirect);
285 
286     public boolean getRestoreCurrentView();
287 
288     public boolean isRestoreCurrentView();
289 
290     public void setRestoreCurrentView(boolean restoreCurrentView);
291 
292     public boolean getMaximizeEdit();
293 
294     public boolean isMaximizeEdit();
295 
296     public void setMaximizeEdit(boolean maximizeEdit);
297 
298     public boolean getMaximizeHelp();
299 
300     public boolean isMaximizeHelp();
301 
302     public void setMaximizeHelp(boolean maximizeHelp);
303 
304     public boolean getPopUpPrint();
305 
306     public boolean isPopUpPrint();
307 
308     public void setPopUpPrint(boolean popUpPrint);
309 
310     public boolean getLayoutCacheable();
311 
312     public boolean isLayoutCacheable();
313 
314     public void setLayoutCacheable(boolean layoutCacheable);
315 
316     public boolean getInstanceable();
317 
318     public boolean isInstanceable();
319 
320     public void setInstanceable(boolean instanceable);
321 
322     public boolean getScopeable();
323 
324     public boolean isScopeable();
325 
326     public void setScopeable(boolean scopeable);
327 
328     public java.lang.String getUserPrincipalStrategy();
329 
330     public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
331 
332     public boolean getPrivateRequestAttributes();
333 
334     public boolean isPrivateRequestAttributes();
335 
336     public void setPrivateRequestAttributes(boolean privateRequestAttributes);
337 
338     public boolean getPrivateSessionAttributes();
339 
340     public boolean isPrivateSessionAttributes();
341 
342     public void setPrivateSessionAttributes(boolean privateSessionAttributes);
343 
344     public int getRenderWeight();
345 
346     public void setRenderWeight(int renderWeight);
347 
348     public boolean getAjaxable();
349 
350     public boolean isAjaxable();
351 
352     public void setAjaxable(boolean ajaxable);
353 
354     public java.util.List<String> getHeaderPortalCss();
355 
356     public void setHeaderPortalCss(java.util.List<String> headerPortalCss);
357 
358     public java.util.List<String> getHeaderPortletCss();
359 
360     public void setHeaderPortletCss(java.util.List<String> headerPortletCss);
361 
362     public java.util.List<String> getHeaderPortalJavaScript();
363 
364     public void setHeaderPortalJavaScript(
365         java.util.List<String> headerPortalJavaScript);
366 
367     public java.util.List<String> getHeaderPortletJavaScript();
368 
369     public void setHeaderPortletJavaScript(
370         java.util.List<String> headerPortletJavaScript);
371 
372     public java.util.List<String> getFooterPortalCss();
373 
374     public void setFooterPortalCss(java.util.List<String> footerPortalCss);
375 
376     public java.util.List<String> getFooterPortletCss();
377 
378     public void setFooterPortletCss(java.util.List<String> footerPortletCss);
379 
380     public java.util.List<String> getFooterPortalJavaScript();
381 
382     public void setFooterPortalJavaScript(
383         java.util.List<String> footerPortalJavaScript);
384 
385     public java.util.List<String> getFooterPortletJavaScript();
386 
387     public void setFooterPortletJavaScript(
388         java.util.List<String> footerPortletJavaScript);
389 
390     public java.lang.String getCssClassWrapper();
391 
392     public void setCssClassWrapper(java.lang.String cssClassWrapper);
393 
394     public java.lang.String getFacebookIntegration();
395 
396     public void setFacebookIntegration(java.lang.String facebookIntegration);
397 
398     public boolean getAddDefaultResource();
399 
400     public boolean isAddDefaultResource();
401 
402     public void setAddDefaultResource(boolean addDefaultResource);
403 
404     public void setRoles(java.lang.String roles);
405 
406     public java.lang.String[] getRolesArray();
407 
408     public void setRolesArray(java.lang.String[] rolesArray);
409 
410     public java.util.Set<String> getUnlinkedRoles();
411 
412     public void setUnlinkedRoles(java.util.Set<String> unlinkedRoles);
413 
414     public java.util.Map<String, String> getRoleMappers();
415 
416     public void setRoleMappers(java.util.Map<String, String> roleMappers);
417 
418     public void linkRoles();
419 
420     public boolean hasRoleWithName(java.lang.String roleName);
421 
422     public boolean hasAddPortletPermission(long userId);
423 
424     public boolean getSystem();
425 
426     public boolean isSystem();
427 
428     public void setSystem(boolean system);
429 
430     public boolean getInclude();
431 
432     public boolean isInclude();
433 
434     public void setInclude(boolean include);
435 
436     public java.util.Map<String, String> getInitParams();
437 
438     public void setInitParams(java.util.Map<String, String> initParams);
439 
440     public java.lang.Integer getExpCache();
441 
442     public void setExpCache(java.lang.Integer expCache);
443 
444     public java.util.Map<String, java.util.Set<String>> getPortletModes();
445 
446     public void setPortletModes(
447         java.util.Map<String, java.util.Set<String>> portletModes);
448 
449     public boolean hasPortletMode(java.lang.String mimeType,
450         javax.portlet.PortletMode portletMode);
451 
452     public java.util.Set<String> getAllPortletModes();
453 
454     public boolean hasMultipleMimeTypes();
455 
456     public java.util.Map<String, java.util.Set<String>> getWindowStates();
457 
458     public void setWindowStates(
459         java.util.Map<String, java.util.Set<String>> windowStates);
460 
461     public boolean hasWindowState(java.lang.String mimeType,
462         javax.portlet.WindowState windowState);
463 
464     public java.util.Set<String> getAllWindowStates();
465 
466     public java.util.Set<String> getSupportedLocales();
467 
468     public void setSupportedLocales(java.util.Set<String> supportedLocales);
469 
470     public java.lang.String getResourceBundle();
471 
472     public void setResourceBundle(java.lang.String resourceBundle);
473 
474     public com.liferay.portal.model.PortletInfo getPortletInfo();
475 
476     public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
477 
478     public java.util.Map<String, com.liferay.portal.model.PortletFilter> getPortletFilters();
479 
480     public void setPortletFilters(
481         java.util.Map<String, com.liferay.portal.model.PortletFilter> portletFilters);
482 
483     public void addProcessingEvent(
484         com.liferay.portal.kernel.xml.QName processingEvent);
485 
486     public com.liferay.portal.kernel.xml.QName getProcessingEvent(
487         java.lang.String uri, java.lang.String localPart);
488 
489     public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
490 
491     public void setProcessingEvents(
492         java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
493 
494     public void addPublishingEvent(
495         com.liferay.portal.kernel.xml.QName publishingEvent);
496 
497     public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
498 
499     public void setPublishingEvents(
500         java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
501 
502     public void addPublicRenderParameter(
503         com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
504 
505     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
506         java.lang.String identifier);
507 
508     public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
509         java.lang.String uri, java.lang.String localPart);
510 
511     public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
512 
513     public void setPublicRenderParameters(
514         java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
515 
516     public java.lang.String getContextPath();
517 
518     public com.liferay.portal.model.PortletApp getPortletApp();
519 
520     public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
521 
522     public com.liferay.portal.model.Portlet getClonedInstance(
523         java.lang.String portletId);
524 
525     public boolean getStatic();
526 
527     public boolean isStatic();
528 
529     public void setStatic(boolean staticPortlet);
530 
531     public boolean getStaticStart();
532 
533     public boolean isStaticStart();
534 
535     public void setStaticStart(boolean staticPortletStart);
536 
537     public boolean getStaticEnd();
538 
539     public boolean isStaticEnd();
540 
541     public boolean getUndeployedPortlet();
542 
543     public boolean isUndeployedPortlet();
544 
545     public void setUndeployedPortlet(boolean undeployedPortlet);
546 
547     public java.lang.Object clone();
548 
549     public int compareTo(com.liferay.portal.model.Portlet portlet);
550 
551     public boolean equals(java.lang.Object obj);
552 }