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