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