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      /**
44      * Gets the root portlet id of the portlet.
45      *
46      * @return the root portlet id of the portlet
47      */
48      public java.lang.String getRootPortletId();
49  
50      /**
51      * Gets the instance id of the portlet.
52      *
53      * @return the instance id of the portlet
54      */
55      public java.lang.String getInstanceId();
56  
57      /**
58      * Gets the plugin id of the portlet.
59      *
60      * @return the plugin id of the portlet
61      */
62      public java.lang.String getPluginId();
63  
64      /**
65      * Gets the plugin type of the portlet.
66      *
67      * @return the plugin type of the portlet
68      */
69      public java.lang.String getPluginType();
70  
71      /**
72      * Get the package to which the portlet belongs to.
73      *
74      * @return the plugin package of the portlet
75      */
76      public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
77  
78      /**
79      * Sets the plugin package this portlet belongs to.
80      *
81      * @param pluginPackage the plugin package
82      */
83      public void setPluginPackage(
84          com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
85  
86      /**
87      * Get the default plugin settings of the portlet.
88      *
89      * @return the plugin settings
90      */
91      public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
92  
93      /**
94      * Sets the default plugin settings of the portlet.
95      *
96      * @param pluginSetting the plugin setting
97      */
98      public void setDefaultPluginSetting(
99          com.liferay.portal.model.PluginSetting pluginSetting);
100 
101     /**
102     * Gets the timestamp of the portlet.
103     *
104     * @return the timestamp of the portlet
105     */
106     public long getTimestamp();
107 
108     /**
109     * Sets the timestamp of the portlet.
110     *
111     * @param timestamp the timestamp of the portlet
112     */
113     public void setTimestamp(long timestamp);
114 
115     /**
116     * Gets the icon of the portlet.
117     *
118     * @return the icon of the portlet
119     */
120     public java.lang.String getIcon();
121 
122     /**
123     * Sets the icon of the portlet.
124     *
125     * @param icon the icon of the portlet
126     */
127     public void setIcon(java.lang.String icon);
128 
129     /**
130     * Gets the virtual path of the portlet.
131     *
132     * @return the virtual path of the portlet
133     */
134     public java.lang.String getVirtualPath();
135 
136     /**
137     * Sets the virtual path of the portlet.
138     *
139     * @param virtualPath the virtual path of the portlet
140     */
141     public void setVirtualPath(java.lang.String virtualPath);
142 
143     /**
144     * Gets the struts path of the portlet.
145     *
146     * @return the struts path of the portlet
147     */
148     public java.lang.String getStrutsPath();
149 
150     /**
151     * Sets the struts path of the portlet.
152     *
153     * @param strutsPath the struts path of the portlet
154     */
155     public void setStrutsPath(java.lang.String strutsPath);
156 
157     /**
158     * Gets the name of the portlet.
159     *
160     * @return the display name of the portlet
161     */
162     public java.lang.String getPortletName();
163 
164     /**
165     * Sets the name of the portlet.
166     *
167     * @param portletName the name of the portlet
168     */
169     public void setPortletName(java.lang.String portletName);
170 
171     /**
172     * Gets the display name of the portlet.
173     *
174     * @return the display name of the portlet
175     */
176     public java.lang.String getDisplayName();
177 
178     /**
179     * Sets the display name of the portlet.
180     *
181     * @param displayName the display name of the portlet
182     */
183     public void setDisplayName(java.lang.String displayName);
184 
185     /**
186     * Gets the name of the portlet class of the portlet.
187     *
188     * @return the name of the portlet class of the portlet
189     */
190     public java.lang.String getPortletClass();
191 
192     /**
193     * Sets the name of the portlet class of the portlet.
194     *
195     * @param portletClass the name of the portlet class of the portlet
196     */
197     public void setPortletClass(java.lang.String portletClass);
198 
199     /**
200     * Gets the configuration action class of the portlet.
201     *
202     * @return the configuration action class of the portlet
203     */
204     public java.lang.String getConfigurationActionClass();
205 
206     /**
207     * Sets the configuration action class of the portlet.
208     *
209     * @param configurationActionClass the configuration action class of the
210     portlet
211     */
212     public void setConfigurationActionClass(
213         java.lang.String configurationActionClass);
214 
215     /**
216     * Gets the configuration action instance of the portlet.
217     *
218     * @return the configuration action instance of the portlet
219     */
220     public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
221 
222     /**
223     * Gets the name of the indexer class of the portlet.
224     *
225     * @return the name of the indexer class of the portlet
226     */
227     public java.lang.String getIndexerClass();
228 
229     /**
230     * Sets the name of the indexer class of the portlet.
231     *
232     * @param indexerClass the name of the indexer class of the portlet
233     */
234     public void setIndexerClass(java.lang.String indexerClass);
235 
236     /**
237     * Gets the indexer instance of the portlet.
238     *
239     * @return the indexer instance of the portlet
240     */
241     public com.liferay.portal.kernel.search.Indexer getIndexerInstance();
242 
243     /**
244     * Gets the name of the open search class of the portlet.
245     *
246     * @return the name of the open search class of the portlet
247     */
248     public java.lang.String getOpenSearchClass();
249 
250     /**
251     * Sets the name of the open search class of the portlet.
252     *
253     * @param openSearchClass the name of the open search class of the portlet
254     */
255     public void setOpenSearchClass(java.lang.String openSearchClass);
256 
257     /**
258     * Gets the indexer instance of the portlet.
259     *
260     * @return the indexer instance of the portlet
261     */
262     public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance();
263 
264     /**
265     * Adds a scheduler entry.
266     */
267     public void addSchedulerEntry(
268         com.liferay.portal.kernel.scheduler.SchedulerEntry schedulerEntry);
269 
270     /**
271     * Gets the scheduler entries of the portlet.
272     *
273     * @return the scheduler entries of the portlet
274     */
275     public java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries();
276 
277     /**
278     * Sets the scheduler entries of the portlet.
279     *
280     * @param schedulerEntries the scheduler entries of the portlet
281     */
282     public void setSchedulerEntries(
283         java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries);
284 
285     /**
286     * Gets the name of the portlet URL class of the portlet.
287     *
288     * @return the name of the portlet URL class of the portlet
289     */
290     public java.lang.String getPortletURLClass();
291 
292     /**
293     * Sets the name of the portlet URL class of the portlet.
294     *
295     * @param portletURLClass the name of the portlet URL class of the portlet
296     */
297     public void setPortletURLClass(java.lang.String portletURLClass);
298 
299     /**
300     * Gets the name of the friendly URL mapper class of the portlet.
301     *
302     * @return the name of the friendly URL mapper class of the portlet
303     */
304     public java.lang.String getFriendlyURLMapperClass();
305 
306     /**
307     * Sets the name of the friendly URL mapper class of the portlet.
308     *
309     * @param friendlyURLMapperClass the name of the friendly URL plugin class
310     of the portlet
311     */
312     public void setFriendlyURLMapperClass(
313         java.lang.String friendlyURLMapperClass);
314 
315     /**
316     * Gets the friendly URL mapper instance of the portlet.
317     *
318     * @return the friendly URL mapper instance of the portlet
319     */
320     public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
321 
322     /**
323     * Gets the class loader resource path to the friendly URL routes of the
324     portlet.
325     *
326     * @return the class loader resource path to the friendly URL routes of the
327     portlet
328     */
329     public java.lang.String getFriendlyURLRoutes();
330 
331     /**
332     * Sets the class loader resource path to the friendly URL routes of the
333     portlet.
334     *
335     * @param friendlyURLRoutes the class loader resource path to the friendly
336     URL routes of the portlet
337     */
338     public void setFriendlyURLRoutes(java.lang.String friendlyURLRoutes);
339 
340     /**
341     * Gets the name of the URL encoder class of the portlet.
342     *
343     * @return the name of the URL encoder class of the portlet
344     */
345     public java.lang.String getURLEncoderClass();
346 
347     /**
348     * Sets the name of the URL encoder class of the portlet.
349     *
350     * @param urlEncoderClass the name of the URL encoder class of the portlet
351     */
352     public void setURLEncoderClass(java.lang.String urlEncoderClass);
353 
354     /**
355     * Gets the URL encoder instance of the portlet.
356     *
357     * @return the URL encoder instance of the portlet
358     */
359     public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
360 
361     /**
362     * Gets the name of the portlet data handler class of the portlet.
363     *
364     * @return the name of the portlet data handler class of the portlet
365     */
366     public java.lang.String getPortletDataHandlerClass();
367 
368     /**
369     * Sets the name of the portlet data handler class of the portlet.
370     *
371     * @param portletDataHandlerClass the name of portlet data handler class of
372     the portlet
373     */
374     public void setPortletDataHandlerClass(
375         java.lang.String portletDataHandlerClass);
376 
377     /**
378     * Gets the portlet data handler instance of the portlet.
379     *
380     * @return the portlet data handler instance of the portlet
381     */
382     public com.liferay.portal.kernel.lar.PortletDataHandler getPortletDataHandlerInstance();
383 
384     /**
385     * Gets the name of the portlet layout listener class of the portlet.
386     *
387     * @return the name of the portlet layout listener class of the portlet
388     */
389     public java.lang.String getPortletLayoutListenerClass();
390 
391     /**
392     * Sets the name of the portlet layout listener class of the portlet.
393     *
394     * @param portletLayoutListenerClass the name of the portlet layout listener
395     class of the portlet
396     */
397     public void setPortletLayoutListenerClass(
398         java.lang.String portletLayoutListenerClass);
399 
400     /**
401     * Gets the portlet layout listener instance of the portlet.
402     *
403     * @return the portlet layout listener instance of the portlet
404     */
405     public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
406 
407     /**
408     * Gets the name of the poller processor class of the portlet.
409     *
410     * @return the name of the poller processor class of the portlet
411     */
412     public java.lang.String getPollerProcessorClass();
413 
414     /**
415     * Sets the name of the poller processor class of the portlet.
416     *
417     * @param pollerProcessorClass the name of the poller processor class of the
418     portlet
419     */
420     public void setPollerProcessorClass(java.lang.String pollerProcessorClass);
421 
422     /**
423     * Gets the poller processor instance of the portlet.
424     *
425     * @return the poller processor instance of the portlet
426     */
427     public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance();
428 
429     /**
430     * Gets the name of the POP message listener class of the portlet.
431     *
432     * @return the name of the POP message listener class of the portlet
433     */
434     public java.lang.String getPopMessageListenerClass();
435 
436     /**
437     * Sets the name of the POP message listener class of the portlet.
438     *
439     * @param popMessageListenerClass the name of the POP message listener class
440     of the portlet
441     */
442     public void setPopMessageListenerClass(
443         java.lang.String popMessageListenerClass);
444 
445     /**
446     * Gets the POP message listener instance of the portlet.
447     *
448     * @return the POP message listener instance of the portlet
449     */
450     public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
451 
452     /**
453     * Gets the name of the social activity interpreter class of the portlet.
454     *
455     * @return the name of the social activity interpreter class of the portlet
456     */
457     public java.lang.String getSocialActivityInterpreterClass();
458 
459     /**
460     * Sets the name of the social activity interpreter class of the portlet.
461     *
462     * @param socialActivityInterpreterClass the name of the activity
463     interpreter class of the portlet
464     */
465     public void setSocialActivityInterpreterClass(
466         java.lang.String socialActivityInterpreterClass);
467 
468     /**
469     * Gets the name of the social activity interpreter instance of the portlet.
470     *
471     * @return the name of the social activity interpreter instance of the
472     portlet
473     */
474     public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
475 
476     /**
477     * Gets the name of the social request interpreter class of the portlet.
478     *
479     * @return the name of the social request interpreter class of the portlet
480     */
481     public java.lang.String getSocialRequestInterpreterClass();
482 
483     /**
484     * Sets the name of the social request interpreter class of the portlet.
485     *
486     * @param socialRequestInterpreterClass the name of the request interpreter
487     class of the portlet
488     */
489     public void setSocialRequestInterpreterClass(
490         java.lang.String socialRequestInterpreterClass);
491 
492     /**
493     * Gets the name of the social request interpreter instance of the portlet.
494     *
495     * @return the name of the social request interpreter instance of the
496     portlet
497     */
498     public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
499 
500     /**
501     * Gets the name of the WebDAV storage token of the portlet.
502     *
503     * @return the name of the WebDAV storage token of the portlet
504     */
505     public java.lang.String getWebDAVStorageToken();
506 
507     /**
508     * Sets the name of the WebDAV storage token of the portlet.
509     *
510     * @param webDAVStorageToken the name of the WebDAV storage token of the
511     portlet
512     */
513     public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
514 
515     /**
516     * Gets the name of the WebDAV storage class of the portlet.
517     *
518     * @return the name of the WebDAV storage class of the portlet
519     */
520     public java.lang.String getWebDAVStorageClass();
521 
522     /**
523     * Sets the name of the WebDAV storage class of the portlet.
524     *
525     * @param webDAVStorageClass the name of the WebDAV storage class of the
526     portlet
527     */
528     public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
529 
530     /**
531     * Gets the name of the WebDAV storage instance of the portlet.
532     *
533     * @return the name of the WebDAV storage instance of the portlet
534     */
535     public com.liferay.portal.kernel.webdav.WebDAVStorage getWebDAVStorageInstance();
536 
537     /**
538     * Gets the name of the XML-RPC method class of the portlet.
539     *
540     * @return the name of the XML-RPC method class of the portlet
541     */
542     public java.lang.String getXmlRpcMethodClass();
543 
544     /**
545     * Sets the name of the XML-RPC method class of the portlet.
546     *
547     * @param xmlRpcMethodClass the name of the XML-RPC method class of the
548     portlet
549     */
550     public void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass);
551 
552     /**
553     * Gets the name of the XML-RPC method instance of the portlet.
554     *
555     * @return the name of the XML-RPC method instance of the portlet
556     */
557     public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance();
558 
559     /**
560     * Gets the name of the category of the Control Panel where the portlet will
561     be shown.
562     *
563     * @return the name of of the category of the Control Panel where the
564     portlet will be shown
565     */
566     public java.lang.String getControlPanelEntryCategory();
567 
568     /**
569     * Set the name of the category of the Control Panel where the portlet will
570     be shown.
571     *
572     * @param controlPanelEntryCategory the name of the category of the Control
573     Panel where the portlet will be shown
574     */
575     public void setControlPanelEntryCategory(
576         java.lang.String controlPanelEntryCategory);
577 
578     /**
579     * Gets the relative weight of the portlet with respect to the other
580     portlets in the same category of the Control Panel.
581     *
582     * @return the relative weight of the portlet with respect to the other
583     portlets in the same category of the Control Panel
584     */
585     public double getControlPanelEntryWeight();
586 
587     /**
588     * Sets the relative weight of the portlet with respect to the other
589     portlets in the same category of the Control Panel.
590     *
591     * @param controlPanelEntryWeight the relative weight of the portlet with
592     respect to the other portlets in the same category of the Control
593     Panel
594     */
595     public void setControlPanelEntryWeight(double controlPanelEntryWeight);
596 
597     /**
598     * Gets the name of the class that will control when the portlet will be
599     shown in the Control Panel.
600     *
601     * @return the name of the class that will control when the portlet will be
602     shown in the Control Panel
603     */
604     public java.lang.String getControlPanelEntryClass();
605 
606     /**
607     * Sets the name of the class that will control when the portlet will be
608     shown in the Control Panel.
609     *
610     * @param controlPanelEntryClass the name of the class that will control
611     when the portlet will be shown in the Control Panel
612     */
613     public void setControlPanelEntryClass(
614         java.lang.String controlPanelEntryClass);
615 
616     /**
617     * Gets an instance of the class that will control when the portlet will be
618     shown in the Control Panel.
619     *
620     * @return the instance of the class that will control when the portlet will
621     be shown in the Control Panel
622     */
623     public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
624 
625     /**
626     * Gets the names of the classes that represent asset types associated to
627     the portlet.
628     *
629     * @return the names of the classes that represent asset types associated to
630     the portlet
631     */
632     public java.util.List<java.lang.String> getAssetRendererFactoryClasses();
633 
634     /**
635     * Sets the name of the classes that represent asset types associated to the
636     portlet.
637     *
638     * @param assetRendererFactoryClasses the names of the classes that
639     represent asset types associated to the portlet
640     */
641     public void setAssetRendererFactoryClasses(
642         java.util.List<java.lang.String> assetRendererFactoryClasses);
643 
644     /**
645     * Gets the asset type instances of the portlet.
646     *
647     * @return the asset type instances of the portlet
648     */
649     public java.util.List<com.liferay.portlet.asset.model.AssetRendererFactory> getAssetRendererFactoryInstances();
650 
651     /**
652     * Gets the names of the classes that represent custom attribute displays
653     associated to the portlet.
654     *
655     * @return the names of the classes that represent asset types associated to
656     the portlet
657     */
658     public java.util.List<java.lang.String> getCustomAttributesDisplayClasses();
659 
660     /**
661     * Sets the name of the classes that represent custom attribute displays
662     associated to the portlet.
663     *
664     * @param customAttributesDisplayClasses the names of the classes that
665     represent custom attribute displays associated to the portlet
666     */
667     public void setCustomAttributesDisplayClasses(
668         java.util.List<java.lang.String> customAttributesDisplayClasses);
669 
670     /**
671     * Gets the custom attribute display instances of the portlet.
672     *
673     * @return the custom attribute display instances of the portlet
674     */
675     public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplayInstances();
676 
677     /**
678     * Gets the names of the classes that represent workflow handlers associated
679     to the portlet.
680     *
681     * @return the names of the classes that represent workflow handlers
682     associated to the portlet
683     */
684     public java.util.List<java.lang.String> getWorkflowHandlerClasses();
685 
686     /**
687     * Sets the name of the classes that represent workflow handlers associated
688     to the portlet.
689     *
690     * @param workflowHandlerClasses the names of the classes that represent
691     workflow handlers associated to the portlet
692     */
693     public void setWorkflowHandlerClasses(
694         java.util.List<java.lang.String> workflowHandlerClasses);
695 
696     /**
697     * Gets the workflow handler instances of the portlet.
698     *
699     * @return the workflow handler instances of the portlet
700     */
701     public java.util.List<com.liferay.portal.kernel.workflow.WorkflowHandler> getWorkflowHandlerInstances();
702 
703     /**
704     * Gets the default preferences of the portlet.
705     *
706     * @return the default preferences of the portlet
707     */
708     public java.lang.String getDefaultPreferences();
709 
710     /**
711     * Sets the default preferences of the portlet.
712     *
713     * @param defaultPreferences the default preferences of the portlet
714     */
715     public void setDefaultPreferences(java.lang.String defaultPreferences);
716 
717     /**
718     * Gets the name of the preferences validator class of the portlet.
719     *
720     * @return the name of the preferences validator class of the portlet
721     */
722     public java.lang.String getPreferencesValidator();
723 
724     /**
725     * Sets the name of the preferences validator class of the portlet.
726     *
727     * @param preferencesValidator the name of the preferences validator class
728     of the portlet
729     */
730     public void setPreferencesValidator(java.lang.String preferencesValidator);
731 
732     /**
733     * Returns true if preferences are shared across the entire company.
734     *
735     * @return true if preferences are shared across the entire company
736     */
737     public boolean getPreferencesCompanyWide();
738 
739     /**
740     * Returns true if preferences are shared across the entire company.
741     *
742     * @return true if preferences are shared across the entire company
743     */
744     public boolean isPreferencesCompanyWide();
745 
746     /**
747     * Set to true if preferences are shared across the entire company.
748     *
749     * @param preferencesCompanyWide boolean value for whether preferences are
750     shared across the entire company
751     */
752     public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
753 
754     /**
755     * Returns true if preferences are unique per layout.
756     *
757     * @return true if preferences are unique per layout
758     */
759     public boolean getPreferencesUniquePerLayout();
760 
761     /**
762     * Returns true if preferences are unique per layout.
763     *
764     * @return true if preferences are unique per layout
765     */
766     public boolean isPreferencesUniquePerLayout();
767 
768     /**
769     * Set to true if preferences are unique per layout.
770     *
771     * @param preferencesUniquePerLayout boolean value for whether preferences
772     are unique per layout
773     */
774     public void setPreferencesUniquePerLayout(
775         boolean preferencesUniquePerLayout);
776 
777     /**
778     * Returns true if preferences are owned by the group when the portlet is
779     shown in a group layout. Returns false if preferences are owned by the
780     user at all times.
781     *
782     * @return true if preferences are owned by the group when the portlet is
783     shown in a group layout; false if preferences are owned by the
784     user at all times.
785     */
786     public boolean getPreferencesOwnedByGroup();
787 
788     /**
789     * Returns true if preferences are owned by the group when the portlet is
790     shown in a group layout. Returns false if preferences are owned by the
791     user at all times.
792     *
793     * @return true if preferences are owned by the group when the portlet is
794     shown in a group layout; false if preferences are owned by the
795     user at all times.
796     */
797     public boolean isPreferencesOwnedByGroup();
798 
799     /**
800     * Set to true if preferences are owned by the group when the portlet is
801     shown in a group layout. Set to false if preferences are owned by the
802     user at all times.
803     *
804     * @param preferencesOwnedByGroup boolean value for whether preferences are
805     owned by the group when the portlet is shown in a group layout or
806     preferences are owned by the user at all times
807     */
808     public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
809 
810     /**
811     * Returns true if the portlet uses the default template.
812     *
813     * @return true if the portlet uses the default template
814     */
815     public boolean getUseDefaultTemplate();
816 
817     /**
818     * Returns true if the portlet uses the default template.
819     *
820     * @return true if the portlet uses the default template
821     */
822     public boolean isUseDefaultTemplate();
823 
824     /**
825     * Set to true if the portlet uses the default template.
826     *
827     * @param useDefaultTemplate boolean value for whether the portlet uses the
828     default template
829     */
830     public void setUseDefaultTemplate(boolean useDefaultTemplate);
831 
832     /**
833     * Returns true if users are shown that they do not have access to the
834     portlet.
835     *
836     * @return true if users are shown that they do not have access to the
837     portlet
838     */
839     public boolean getShowPortletAccessDenied();
840 
841     /**
842     * Returns true if users are shown that they do not have access to the
843     portlet.
844     *
845     * @return true if users are shown that they do not have access to the
846     portlet
847     */
848     public boolean isShowPortletAccessDenied();
849 
850     /**
851     * Set to true if users are shown that they do not have access to the
852     portlet.
853     *
854     * @param showPortletAccessDenied boolean value for whether users are shown
855     that they do not have access to the portlet
856     */
857     public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
858 
859     /**
860     * Returns true if users are shown that the portlet is inactive.
861     *
862     * @return true if users are shown that the portlet is inactive
863     */
864     public boolean getShowPortletInactive();
865 
866     /**
867     * Returns true if users are shown that the portlet is inactive.
868     *
869     * @return true if users are shown that the portlet is inactive
870     */
871     public boolean isShowPortletInactive();
872 
873     /**
874     * Set to true if users are shown that the portlet is inactive.
875     *
876     * @param showPortletInactive boolean value for whether users are shown that
877     the portlet is inactive
878     */
879     public void setShowPortletInactive(boolean showPortletInactive);
880 
881     /**
882     * Returns true if an action URL for this portlet should cause an auto
883     redirect.
884     *
885     * @return true if an action URL for this portlet should cause an auto
886     redirect
887     */
888     public boolean getActionURLRedirect();
889 
890     /**
891     * Returns true if an action URL for this portlet should cause an auto
892     redirect.
893     *
894     * @return true if an action URL for this portlet should cause an auto
895     redirect
896     */
897     public boolean isActionURLRedirect();
898 
899     /**
900     * Set to true if an action URL for this portlet should cause an auto
901     redirect.
902     *
903     * @param actionURLRedirect boolean value for whether an action URL for this
904     portlet should cause an auto redirect
905     */
906     public void setActionURLRedirect(boolean actionURLRedirect);
907 
908     /**
909     * Returns true if the portlet restores to the current view from the
910     maximized state.
911     *
912     * @return true if the portlet restores to the current view from the
913     maximized state
914     */
915     public boolean getRestoreCurrentView();
916 
917     /**
918     * Returns true if the portlet restores to the current view from the
919     maximized state.
920     *
921     * @return true if the portlet restores to the current view from the
922     maximized state
923     */
924     public boolean isRestoreCurrentView();
925 
926     /**
927     * Set to true if the portlet restores to the current view from the
928     maximized state.
929     *
930     * @param restoreCurrentView boolean value for whether the portlet restores
931     to the current view from the maximized state
932     */
933     public void setRestoreCurrentView(boolean restoreCurrentView);
934 
935     /**
936     * Returns true if the portlet goes into the maximized state when the user
937     goes into the edit mode.
938     *
939     * @return true if the portlet goes into the maximized state when the user
940     goes into the edit mode
941     */
942     public boolean getMaximizeEdit();
943 
944     /**
945     * Returns true if the portlet goes into the maximized state when the user
946     goes into the edit mode.
947     *
948     * @return true if the portlet goes into the maximized state when the user
949     goes into the edit mode
950     */
951     public boolean isMaximizeEdit();
952 
953     /**
954     * Set to true if the portlet goes into the maximized state when the user
955     goes into the edit mode.
956     *
957     * @param maximizeEdit boolean value for whether the portlet goes into the
958     maximized state when the user goes into the edit mode
959     */
960     public void setMaximizeEdit(boolean maximizeEdit);
961 
962     /**
963     * Returns true if the portlet goes into the maximized state when the user
964     goes into the help mode.
965     *
966     * @return true if the portlet goes into the maximized state when the user
967     goes into the help mode
968     */
969     public boolean getMaximizeHelp();
970 
971     /**
972     * Returns true if the portlet goes into the maximized state when the user
973     goes into the help mode.
974     *
975     * @return true if the portlet goes into the maximized state when the user
976     goes into the help mode
977     */
978     public boolean isMaximizeHelp();
979 
980     /**
981     * Set to true if the portlet goes into the maximized state when the user
982     goes into the help mode.
983     *
984     * @param maximizeHelp boolean value for whether the portlet goes into the
985     maximized state when the user goes into the help mode
986     */
987     public void setMaximizeHelp(boolean maximizeHelp);
988 
989     /**
990     * Returns true if the portlet goes into the pop up state when the user goes
991     into the print mode.
992     *
993     * @return true if the portlet goes into the pop up state when the user goes
994     into the print mode
995     */
996     public boolean getPopUpPrint();
997 
998     /**
999     * Returns true if the portlet goes into the pop up state when the user goes
1000    into the print mode.
1001    *
1002    * @return true if the portlet goes into the pop up state when the user goes
1003    into the print mode
1004    */
1005    public boolean isPopUpPrint();
1006
1007    /**
1008    * Set to true if the portlet goes into the pop up state when the user goes
1009    into the print mode.
1010    *
1011    * @param popUpPrint boolean value for whether the portlet goes into the pop
1012    up state when the user goes into the print mode
1013    */
1014    public void setPopUpPrint(boolean popUpPrint);
1015
1016    /**
1017    * Returns true to allow the portlet to be cached within the layout.
1018    *
1019    * @return true if the portlet can be cached within the layout
1020    */
1021    public boolean getLayoutCacheable();
1022
1023    /**
1024    * Returns true to allow the portlet to be cached within the layout.
1025    *
1026    * @return true if the portlet can be cached within the layout
1027    */
1028    public boolean isLayoutCacheable();
1029
1030    /**
1031    * Set to true to allow the portlet to be cached within the layout.
1032    *
1033    * @param layoutCacheable boolean value for whether the portlet can be
1034    cached within the layout
1035    */
1036    public void setLayoutCacheable(boolean layoutCacheable);
1037
1038    /**
1039    * Returns true if the portlet can be added multiple times to a layout.
1040    *
1041    * @return true if the portlet can be added multiple times to a layout
1042    */
1043    public boolean getInstanceable();
1044
1045    /**
1046    * Returns true if the portlet can be added multiple times to a layout.
1047    *
1048    * @return true if the portlet can be added multiple times to a layout
1049    */
1050    public boolean isInstanceable();
1051
1052    /**
1053    * Set to true if the portlet can be added multiple times to a layout.
1054    *
1055    * @param instanceable boolean value for whether the portlet can be added
1056    multiple times to a layout
1057    */
1058    public void setInstanceable(boolean instanceable);
1059
1060    /**
1061    * Returns true if the portlet supports scoping of data.
1062    *
1063    * @return true if the portlet supports scoping of data
1064    */
1065    public boolean getScopeable();
1066
1067    /**
1068    * Returns true if the portlet supports scoping of data.
1069    *
1070    * @return true if the portlet supports scoping of data
1071    */
1072    public boolean isScopeable();
1073
1074    /**
1075    * Set to true if the portlet supports scoping of data.
1076    *
1077    * @param scopeable boolean value for whether or not the the portlet
1078    supports scoping of data
1079    */
1080    public void setScopeable(boolean scopeable);
1081
1082    /**
1083    * Gets the user principal strategy of the portlet.
1084    *
1085    * @return the user principal strategy of the portlet
1086    */
1087    public java.lang.String getUserPrincipalStrategy();
1088
1089    /**
1090    * Sets the user principal strategy of the portlet.
1091    *
1092    * @param userPrincipalStrategy the user principal strategy of the portlet
1093    */
1094    public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
1095
1096    /**
1097    * Returns true if the portlet does not share request attributes with the
1098    portal or portlets from another WAR.
1099    *
1100    * @return true if the portlet does not share request attributes with the
1101    portal or portlets from another WAR
1102    */
1103    public boolean getPrivateRequestAttributes();
1104
1105    /**
1106    * Returns true if the portlet does not share request attributes with the
1107    portal or portlets from another WAR.
1108    *
1109    * @return true if the portlet does not share request attributes with the
1110    portal or portlets from another WAR
1111    */
1112    public boolean isPrivateRequestAttributes();
1113
1114    /**
1115    * Set to true if the portlet does not share request attributes with the
1116    portal or portlets from another WAR.
1117    *
1118    * @param privateRequestAttributes boolean value for whether the portlet
1119    shares request attributes with the portal or portlets from another
1120    WAR
1121    */
1122    public void setPrivateRequestAttributes(boolean privateRequestAttributes);
1123
1124    /**
1125    * Returns true if the portlet does not share session attributes with the
1126    portal.
1127    *
1128    * @return true if the portlet does not share session attributes with the
1129    portal
1130    */
1131    public boolean getPrivateSessionAttributes();
1132
1133    /**
1134    * Returns true if the portlet does not share session attributes with the
1135    portal.
1136    *
1137    * @return true if the portlet does not share session attributes with the
1138    portal
1139    */
1140    public boolean isPrivateSessionAttributes();
1141
1142    /**
1143    * Set to true if the portlet does not share session attributes with the
1144    portal.
1145    *
1146    * @param privateSessionAttributes boolean value for whether the portlet
1147    shares session attributes with the portal
1148    */
1149    public void setPrivateSessionAttributes(boolean privateSessionAttributes);
1150
1151    /**
1152    * Returns the render weight of the portlet.
1153    *
1154    * @return the render weight of the portlet
1155    */
1156    public int getRenderWeight();
1157
1158    /**
1159    * Sets the render weight of the portlet.
1160    *
1161    * @param renderWeight int value for the render weight of the portlet
1162    */
1163    public void setRenderWeight(int renderWeight);
1164
1165    /**
1166    * Returns true if the portlet can be displayed via Ajax.
1167    *
1168    * @return true if the portlet can be displayed via Ajax
1169    */
1170    public boolean getAjaxable();
1171
1172    /**
1173    * Returns true if the portlet can be displayed via Ajax.
1174    *
1175    * @return true if the portlet can be displayed via Ajax
1176    */
1177    public boolean isAjaxable();
1178
1179    /**
1180    * Set to true if the portlet can be displayed via Ajax.
1181    *
1182    * @param ajaxable boolean value for whether the portlet can be displayed
1183    via Ajax
1184    */
1185    public void setAjaxable(boolean ajaxable);
1186
1187    /**
1188    * Gets a list of CSS files that will be referenced from the page's header
1189    relative to the portal's context path.
1190    *
1191    * @return a list of CSS files that will be referenced from the page's
1192    header relative to the portal's context path
1193    */
1194    public java.util.List<java.lang.String> getHeaderPortalCss();
1195
1196    /**
1197    * Sets a list of CSS files that will be referenced from the page's header
1198    relative to the portal's context path.
1199    *
1200    * @param headerPortalCss a list of CSS files that will be referenced from
1201    the page's header relative to the portal's context path
1202    */
1203    public void setHeaderPortalCss(
1204        java.util.List<java.lang.String> headerPortalCss);
1205
1206    /**
1207    * Gets a list of CSS files that will be referenced from the page's header
1208    relative to the portlet's context path.
1209    *
1210    * @return a list of CSS files that will be referenced from the page's
1211    header relative to the portlet's context path
1212    */
1213    public java.util.List<java.lang.String> getHeaderPortletCss();
1214
1215    /**
1216    * Sets a list of CSS files that will be referenced from the page's header
1217    relative to the portlet's context path.
1218    *
1219    * @param headerPortletCss a list of CSS files that will be referenced from
1220    the page's header relative to the portlet's context path
1221    */
1222    public void setHeaderPortletCss(
1223        java.util.List<java.lang.String> headerPortletCss);
1224
1225    /**
1226    * Gets a list of JavaScript files that will be referenced from the page's
1227    header relative to the portal's context path.
1228    *
1229    * @return a list of JavaScript files that will be referenced from the
1230    page's header relative to the portal's context path
1231    */
1232    public java.util.List<java.lang.String> getHeaderPortalJavaScript();
1233
1234    /**
1235    * Sets a list of JavaScript files that will be referenced from the page's
1236    header relative to the portal's context path.
1237    *
1238    * @param headerPortalJavaScript a list of JavaScript files that will be
1239    referenced from the page's header relative to the portal's context
1240    path
1241    */
1242    public void setHeaderPortalJavaScript(
1243        java.util.List<java.lang.String> headerPortalJavaScript);
1244
1245    /**
1246    * Gets a list of JavaScript files that will be referenced from the page's
1247    header relative to the portlet's context path.
1248    *
1249    * @return a list of JavaScript files that will be referenced from the
1250    page's header relative to the portlet's context path
1251    */
1252    public java.util.List<java.lang.String> getHeaderPortletJavaScript();
1253
1254    /**
1255    * Sets a list of JavaScript files that will be referenced from the page's
1256    header relative to the portlet's context path.
1257    *
1258    * @param headerPortletJavaScript a list of JavaScript files that will be
1259    referenced from the page's header relative to the portlet's
1260    context path
1261    */
1262    public void setHeaderPortletJavaScript(
1263        java.util.List<java.lang.String> headerPortletJavaScript);
1264
1265    /**
1266    * Gets a list of CSS files that will be referenced from the page's footer
1267    relative to the portal's context path.
1268    *
1269    * @return a list of CSS files that will be referenced from the page's
1270    footer relative to the portal's context path
1271    */
1272    public java.util.List<java.lang.String> getFooterPortalCss();
1273
1274    /**
1275    * Sets a list of CSS files that will be referenced from the page's footer
1276    relative to the portal's context path.
1277    *
1278    * @param footerPortalCss a list of CSS files that will be referenced from
1279    the page's footer relative to the portal's context path
1280    */
1281    public void setFooterPortalCss(
1282        java.util.List<java.lang.String> footerPortalCss);
1283
1284    /**
1285    * Gets a list of CSS files that will be referenced from the page's footer
1286    relative to the portlet's context path.
1287    *
1288    * @return a list of CSS files that will be referenced from the page's
1289    footer relative to the portlet's context path
1290    */
1291    public java.util.List<java.lang.String> getFooterPortletCss();
1292
1293    /**
1294    * Sets a list of CSS files that will be referenced from the page's footer
1295    relative to the portlet's context path.
1296    *
1297    * @param footerPortletCss a list of CSS files that will be referenced from
1298    the page's footer relative to the portlet's context path
1299    */
1300    public void setFooterPortletCss(
1301        java.util.List<java.lang.String> footerPortletCss);
1302
1303    /**
1304    * Gets a list of JavaScript files that will be referenced from the page's
1305    footer relative to the portal's context path.
1306    *
1307    * @return a list of JavaScript files that will be referenced from the
1308    page's footer relative to the portal's context path
1309    */
1310    public java.util.List<java.lang.String> getFooterPortalJavaScript();
1311
1312    /**
1313    * Sets a list of JavaScript files that will be referenced from the page's
1314    footer relative to the portal's context path.
1315    *
1316    * @param footerPortalJavaScript a list of JavaScript files that will be
1317    referenced from the page's footer relative to the portal's context
1318    path
1319    */
1320    public void setFooterPortalJavaScript(
1321        java.util.List<java.lang.String> footerPortalJavaScript);
1322
1323    /**
1324    * Gets a list of JavaScript files that will be referenced from the page's
1325    footer relative to the portlet's context path.
1326    *
1327    * @return a list of JavaScript files that will be referenced from the
1328    page's footer relative to the portlet's context path
1329    */
1330    public java.util.List<java.lang.String> getFooterPortletJavaScript();
1331
1332    /**
1333    * Sets a list of JavaScript files that will be referenced from the page's
1334    footer relative to the portlet's context path.
1335    *
1336    * @param footerPortletJavaScript a list of JavaScript files that will be
1337    referenced from the page's footer relative to the portlet's
1338    context path
1339    */
1340    public void setFooterPortletJavaScript(
1341        java.util.List<java.lang.String> footerPortletJavaScript);
1342
1343    /**
1344    * Gets the name of the CSS class that will be injected in the DIV that
1345    wraps this portlet.
1346    *
1347    * @return the name of the CSS class that will be injected in the DIV that
1348    wraps this portlet
1349    */
1350    public java.lang.String getCssClassWrapper();
1351
1352    /**
1353    * Sets the name of the CSS class that will be injected in the DIV that
1354    wraps this portlet.
1355    *
1356    * @param cssClassWrapper the name of the CSS class that will be injected in
1357    the DIV that wraps this portlet
1358    */
1359    public void setCssClassWrapper(java.lang.String cssClassWrapper);
1360
1361    /**
1362    * Gets the Facebook integration method of the portlet.
1363    *
1364    * @return the Facebook integration method of the portlet
1365    */
1366    public java.lang.String getFacebookIntegration();
1367
1368    /**
1369    * Sets the Facebook integration method of the portlet.
1370    *
1371    * @param facebookIntegration the Facebook integration method of the portlet
1372    */
1373    public void setFacebookIntegration(java.lang.String facebookIntegration);
1374
1375    /**
1376    * Returns true if default resources for the portlet are added to a page.
1377    *
1378    * @return true if default resources for the portlet are added to a page
1379    */
1380    public boolean getAddDefaultResource();
1381
1382    /**
1383    * Returns true if default resources for the portlet are added to a page.
1384    *
1385    * @return true if default resources for the portlet are added to a page
1386    */
1387    public boolean isAddDefaultResource();
1388
1389    /**
1390    * Set to true if default resources for the portlet are added to a page.
1391    *
1392    * @param addDefaultResource boolean value for whether or not default
1393    resources for the portlet are added to a page
1394    */
1395    public void setAddDefaultResource(boolean addDefaultResource);
1396
1397    /**
1398    * Sets a string of ordered comma delimited portlet ids.
1399    *
1400    * @param roles a string of ordered comma delimited portlet ids
1401    */
1402    public void setRoles(java.lang.String roles);
1403
1404    /**
1405    * Gets an array of required roles of the portlet.
1406    *
1407    * @return an array of required roles of the portlet
1408    */
1409    public java.lang.String[] getRolesArray();
1410
1411    /**
1412    * Sets an array of required roles of the portlet.
1413    *
1414    * @param rolesArray an array of required roles of the portlet
1415    */
1416    public void setRolesArray(java.lang.String[] rolesArray);
1417
1418    /**
1419    * Gets the unlinked roles of the portlet.
1420    *
1421    * @return unlinked roles of the portlet
1422    */
1423    public java.util.Set<java.lang.String> getUnlinkedRoles();
1424
1425    /**
1426    * Sets the unlinked roles of the portlet.
1427    *
1428    * @param unlinkedRoles the unlinked roles of the portlet
1429    */
1430    public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles);
1431
1432    /**
1433    * Gets the role mappers of the portlet.
1434    *
1435    * @return role mappers of the portlet
1436    */
1437    public java.util.Map<java.lang.String, java.lang.String> getRoleMappers();
1438
1439    /**
1440    * Sets the role mappers of the portlet.
1441    *
1442    * @param roleMappers the role mappers of the portlet
1443    */
1444    public void setRoleMappers(
1445        java.util.Map<java.lang.String, java.lang.String> roleMappers);
1446
1447    /**
1448    * Link the role names set in portlet.xml with the Liferay roles set in
1449    liferay-portlet.xml.
1450    */
1451    public void linkRoles();
1452
1453    /**
1454    * Returns true if the portlet has a role with the specified name.
1455    *
1456    * @return true if the portlet has a role with the specified name
1457    */
1458    public boolean hasRoleWithName(java.lang.String roleName);
1459
1460    /**
1461    * Returns true if the user has the permission to add the portlet to a
1462    layout.
1463    *
1464    * @return true if the user has the permission to add the portlet to a
1465    layout
1466    */
1467    public boolean hasAddPortletPermission(long userId);
1468
1469    /**
1470    * Returns true if the portlet is a system portlet that a user cannot
1471    manually add to their page.
1472    *
1473    * @return true if the portlet is a system portlet that a user cannot
1474    manually add to their page
1475    */
1476    public boolean getSystem();
1477
1478    /**
1479    * Returns true if the portlet is a system portlet that a user cannot
1480    manually add to their page.
1481    *
1482    * @return true if the portlet is a system portlet that a user cannot
1483    manually add to their page
1484    */
1485    public boolean isSystem();
1486
1487    /**
1488    * Set to true if the portlet is a system portlet that a user cannot
1489    manually add to their page.
1490    *
1491    * @param system boolean value for whether the portlet is a system portlet
1492    that a user cannot manually add to their page
1493    */
1494    public void setSystem(boolean system);
1495
1496    /**
1497    * Returns true to include the portlet and make it available to be made
1498    active.
1499    *
1500    * @return true to include the portlet and make it available to be made
1501    active
1502    */
1503    public boolean getInclude();
1504
1505    /**
1506    * Returns true to include the portlet and make it available to be made
1507    active.
1508    *
1509    * @return true to include the portlet and make it available to be made
1510    active
1511    */
1512    public boolean isInclude();
1513
1514    /**
1515    * Set to true to include the portlet and make it available to be made
1516    active.
1517    *
1518    * @param include boolean value for whether to include the portlet and make
1519    it available to be made active
1520    */
1521    public void setInclude(boolean include);
1522
1523    /**
1524    * Gets the init parameters of the portlet.
1525    *
1526    * @return init parameters of the portlet
1527    */
1528    public java.util.Map<java.lang.String, java.lang.String> getInitParams();
1529
1530    /**
1531    * Sets the init parameters of the portlet.
1532    *
1533    * @param initParams the init parameters of the portlet
1534    */
1535    public void setInitParams(
1536        java.util.Map<java.lang.String, java.lang.String> initParams);
1537
1538    /**
1539    * Gets expiration cache of the portlet.
1540    *
1541    * @return expiration cache of the portlet
1542    */
1543    public java.lang.Integer getExpCache();
1544
1545    /**
1546    * Sets expiration cache of the portlet.
1547    *
1548    * @param expCache expiration cache of the portlet
1549    */
1550    public void setExpCache(java.lang.Integer expCache);
1551
1552    /**
1553    * Gets the portlet modes of the portlet.
1554    *
1555    * @return portlet modes of the portlet
1556    */
1557    public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getPortletModes();
1558
1559    /**
1560    * Sets the portlet modes of the portlet.
1561    *
1562    * @param portletModes the portlet modes of the portlet
1563    */
1564    public void setPortletModes(
1565        java.util.Map<java.lang.String, java.util.Set<java.lang.String>> portletModes);
1566
1567    /**
1568    * Returns true if the portlet supports the specified mime type and portlet
1569    mode.
1570    *
1571    * @return true if the portlet supports the specified mime type and portlet
1572    mode
1573    */
1574    public boolean hasPortletMode(java.lang.String mimeType,
1575        javax.portlet.PortletMode portletMode);
1576
1577    /**
1578    * Gets a list of all portlet modes supported by the portlet.
1579    *
1580    * @return a list of all portlet modes supported by the portlet
1581    */
1582    public java.util.Set<java.lang.String> getAllPortletModes();
1583
1584    /**
1585    * Returns true if the portlet supports more than one mime type.
1586    *
1587    * @return true if the portlet supports more than one mime type
1588    */
1589    public boolean hasMultipleMimeTypes();
1590
1591    /**
1592    * Gets the window states of the portlet.
1593    *
1594    * @return window states of the portlet
1595    */
1596    public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getWindowStates();
1597
1598    /**
1599    * Sets the window states of the portlet.
1600    *
1601    * @param windowStates the window states of the portlet
1602    */
1603    public void setWindowStates(
1604        java.util.Map<java.lang.String, java.util.Set<java.lang.String>> windowStates);
1605
1606    /**
1607    * Returns true if the portlet supports the specified mime type and window
1608    state.
1609    *
1610    * @return true if the portlet supports the specified mime type and window
1611    state
1612    */
1613    public boolean hasWindowState(java.lang.String mimeType,
1614        javax.portlet.WindowState windowState);
1615
1616    /**
1617    * Gets a list of all window states supported by the portlet.
1618    *
1619    * @return a list of all window states supported by the portlet
1620    */
1621    public java.util.Set<java.lang.String> getAllWindowStates();
1622
1623    /**
1624    * Gets the supported locales of the portlet.
1625    *
1626    * @return supported locales of the portlet
1627    */
1628    public java.util.Set<java.lang.String> getSupportedLocales();
1629
1630    /**
1631    * Sets the supported locales of the portlet.
1632    *
1633    * @param supportedLocales the supported locales of the portlet
1634    */
1635    public void setSupportedLocales(
1636        java.util.Set<java.lang.String> supportedLocales);
1637
1638    /**
1639    * Gets the resource bundle of the portlet.
1640    *
1641    * @return resource bundle of the portlet
1642    */
1643    public java.lang.String getResourceBundle();
1644
1645    /**
1646    * Sets the resource bundle of the portlet.
1647    *
1648    * @param resourceBundle the resource bundle of the portlet
1649    */
1650    public void setResourceBundle(java.lang.String resourceBundle);
1651
1652    /**
1653    * Gets the portlet info of the portlet.
1654    *
1655    * @return portlet info of the portlet
1656    */
1657    public com.liferay.portal.model.PortletInfo getPortletInfo();
1658
1659    /**
1660    * Sets the portlet info of the portlet.
1661    *
1662    * @param portletInfo the portlet info of the portlet
1663    */
1664    public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
1665
1666    /**
1667    * Gets the filters of the portlet.
1668    *
1669    * @return filters of the portlet
1670    */
1671    public java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> getPortletFilters();
1672
1673    /**
1674    * Sets the filters of the portlet.
1675    *
1676    * @param portletFilters the filters of the portlet
1677    */
1678    public void setPortletFilters(
1679        java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> portletFilters);
1680
1681    /**
1682    * Adds a supported processing event.
1683    */
1684    public void addProcessingEvent(
1685        com.liferay.portal.kernel.xml.QName processingEvent);
1686
1687    /**
1688    * Gets the supported processing event from a namespace URI and a local
1689    part.
1690    *
1691    * @return the supported processing event from a namespace URI and a local
1692    part
1693    */
1694    public com.liferay.portal.kernel.xml.QName getProcessingEvent(
1695        java.lang.String uri, java.lang.String localPart);
1696
1697    /**
1698    * Gets the supported processing events of the portlet.
1699    *
1700    * @return supported processing events of the portlet
1701    */
1702    public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
1703
1704    /**
1705    * Sets the supported processing events of the portlet.
1706    *
1707    * @param processingEvents the supported processing events of the portlet
1708    */
1709    public void setProcessingEvents(
1710        java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
1711
1712    /**
1713    * Adds a supported publishing event.
1714    */
1715    public void addPublishingEvent(
1716        com.liferay.portal.kernel.xml.QName publishingEvent);
1717
1718    /**
1719    * Gets the supported publishing events of the portlet.
1720    *
1721    * @return supported publishing events of the portlet
1722    */
1723    public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
1724
1725    /**
1726    * Sets the supported publishing events of the portlet.
1727    *
1728    * @param publishingEvents the supported publishing events of the portlet
1729    */
1730    public void setPublishingEvents(
1731        java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
1732
1733    /**
1734    * Adds a supported public render parameter.
1735    *
1736    * @param publicRenderParameter a supported public render parameter
1737    */
1738    public void addPublicRenderParameter(
1739        com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
1740
1741    /**
1742    * Gets the supported public render parameter from an identifier.
1743    *
1744    * @return the supported public render parameter from an identifier
1745    */
1746    public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
1747        java.lang.String identifier);
1748
1749    /**
1750    * Gets the supported public render parameter from a namespace URI and a
1751    local part.
1752    *
1753    * @return the supported public render parameter from a namespace URI and a
1754    local part
1755    */
1756    public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
1757        java.lang.String uri, java.lang.String localPart);
1758
1759    /**
1760    * Gets the supported public render parameters of the portlet.
1761    *
1762    * @return the supported public render parameters of the portlet
1763    */
1764    public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
1765
1766    /**
1767    * Sets the supported public render parameters of the portlet.
1768    *
1769    * @param publicRenderParameters the supported public render parameters of
1770    the portlet
1771    */
1772    public void setPublicRenderParameters(
1773        java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
1774
1775    /**
1776    * Gets the servlet context path of the portlet.
1777    *
1778    * @return the servlet context path of the portlet
1779    */
1780    public java.lang.String getContextPath();
1781
1782    /**
1783    * Get the application this portlet belongs to.
1784    *
1785    * @return the application this portlet belongs to
1786    */
1787    public com.liferay.portal.model.PortletApp getPortletApp();
1788
1789    /**
1790    * Sets the application this portlet belongs to.
1791    *
1792    * @param portletApp the application this portlet belongs to
1793    */
1794    public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
1795
1796    /**
1797    * Returns true if the portlet is found in a WAR file.
1798    *
1799    * @param portletId the cloned instance portlet id
1800    * @return a cloned instance of the portlet
1801    */
1802    public com.liferay.portal.model.Portlet getClonedInstance(
1803        java.lang.String portletId);
1804
1805    /**
1806    * Returns true if the portlet is a static portlet that is cannot be moved.
1807    *
1808    * @return true if the portlet is a static portlet that is cannot be moved
1809    */
1810    public boolean getStatic();
1811
1812    /**
1813    * Returns true if the portlet is a static portlet that is cannot be moved.
1814    *
1815    * @return true if the portlet is a static portlet that is cannot be moved
1816    */
1817    public boolean isStatic();
1818
1819    /**
1820    * Set to true if the portlet is a static portlet that is cannot be moved.
1821    *
1822    * @param staticPortlet boolean value for whether the portlet is a static
1823    portlet that cannot be moved
1824    */
1825    public void setStatic(boolean staticPortlet);
1826
1827    /**
1828    * Returns true if the portlet is a static portlet at the start of a list of
1829    portlets.
1830    *
1831    * @return true if the portlet is a static portlet at the start of a list of
1832    portlets
1833    */
1834    public boolean getStaticStart();
1835
1836    /**
1837    * Returns true if the portlet is a static portlet at the start of a list of
1838    portlets.
1839    *
1840    * @return true if the portlet is a static portlet at the start of a list of
1841    portlets
1842    */
1843    public boolean isStaticStart();
1844
1845    /**
1846    * Set to true if the portlet is a static portlet at the start of a list of
1847    portlets.
1848    *
1849    * @param staticPortletStart boolean value for whether the portlet is a
1850    static portlet at the start of a list of portlets
1851    */
1852    public void setStaticStart(boolean staticPortletStart);
1853
1854    /**
1855    * Returns true if the portlet is a static portlet at the end of a list of
1856    portlets.
1857    *
1858    * @return true if the portlet is a static portlet at the end of a list of
1859    portlets
1860    */
1861    public boolean getStaticEnd();
1862
1863    /**
1864    * Returns true if the portlet is a static portlet at the end of a list of
1865    portlets.
1866    *
1867    * @return true if the portlet is a static portlet at the end of a list of
1868    portlets
1869    */
1870    public boolean isStaticEnd();
1871
1872    /**
1873    * Returns true if the portlet is an undeployed portlet.
1874    *
1875    * @return true if the portlet is a placeholder of an undeployed portlet
1876    */
1877    public boolean getUndeployedPortlet();
1878
1879    /**
1880    * Returns true if the portlet is an undeployed portlet.
1881    *
1882    * @return true if the portlet is a placeholder of an undeployed portlet
1883    */
1884    public boolean isUndeployedPortlet();
1885
1886    /**
1887    * Set to true if the portlet is an undeployed portlet.
1888    *
1889    * @param undeployedPortlet boolean value for whether the portlet is an
1890    undeployed portlet
1891    */
1892    public void setUndeployedPortlet(boolean undeployedPortlet);
1893
1894    /**
1895    * Creates and returns a copy of this object.
1896    *
1897    * @return a copy of this object
1898    */
1899    public java.lang.Object clone();
1900
1901    /**
1902    * Compares this portlet to the specified object.
1903    *
1904    * @param portlet the portlet to compare this portlet against
1905    * @return the value 0 if the argument portlet is equal to this portlet; a
1906    value less than -1 if this portlet is less than the portlet
1907    argument; and 1 if this portlet is greater than the portlet
1908    argument
1909    */
1910    public int compareTo(com.liferay.portal.model.Portlet portlet);
1911
1912    /**
1913    * Checks whether this portlet is equal to the specified object.
1914    *
1915    * @param obj the object to compare this portlet against
1916    * @return true if the portlet is equal to the specified object
1917    */
1918    public boolean equals(java.lang.Object obj);
1919}