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