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