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