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