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