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