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