001    /**
002     * Copyright (c) 2000-2013 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 filters of the portlet.
611            *
612            * @return filters of the portlet
613            */
614            public java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> getPortletFilters();
615    
616            /**
617            * Returns the portlet info of the portlet.
618            *
619            * @return portlet info of the portlet
620            */
621            public com.liferay.portal.model.PortletInfo getPortletInfo();
622    
623            /**
624            * Returns the name of the portlet layout listener class of the portlet.
625            *
626            * @return the name of the portlet layout listener class of the portlet
627            */
628            public java.lang.String getPortletLayoutListenerClass();
629    
630            /**
631            * Returns the portlet layout listener instance of the portlet.
632            *
633            * @return the portlet layout listener instance of the portlet
634            */
635            public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
636    
637            /**
638            * Returns the portlet modes of the portlet.
639            *
640            * @return portlet modes of the portlet
641            */
642            public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getPortletModes();
643    
644            /**
645            * Returns the name of the portlet.
646            *
647            * @return the display name of the portlet
648            */
649            public java.lang.String getPortletName();
650    
651            /**
652            * Returns the name of the portlet URL class of the portlet.
653            *
654            * @return the name of the portlet URL class of the portlet
655            */
656            public java.lang.String getPortletURLClass();
657    
658            /**
659            * Returns <code>true</code> if preferences are shared across the entire
660            * company.
661            *
662            * @return <code>true</code> if preferences are shared across the entire
663            company
664            */
665            public boolean getPreferencesCompanyWide();
666    
667            /**
668            * Returns <code>true</code> if preferences are owned by the group when the
669            * portlet is shown in a group layout. Returns <code>false</code> if
670            * preferences are owned by the user at all times.
671            *
672            * @return <code>true</code> if preferences are owned by the group when the
673            portlet is shown in a group layout; <code>false</code> if
674            preferences are owned by the user at all times.
675            */
676            public boolean getPreferencesOwnedByGroup();
677    
678            /**
679            * Returns <code>true</code> if preferences are unique per layout.
680            *
681            * @return <code>true</code> if preferences are unique per layout
682            */
683            public boolean getPreferencesUniquePerLayout();
684    
685            /**
686            * Returns the name of the preferences validator class of the portlet.
687            *
688            * @return the name of the preferences validator class of the portlet
689            */
690            public java.lang.String getPreferencesValidator();
691    
692            /**
693            * Returns <code>true</code> if the portlet does not share request
694            * attributes with the portal or portlets from another WAR.
695            *
696            * @return <code>true</code> if the portlet does not share request
697            attributes with the portal or portlets from another WAR
698            */
699            public boolean getPrivateRequestAttributes();
700    
701            /**
702            * Returns <code>true</code> if the portlet does not share session
703            * attributes with the portal.
704            *
705            * @return <code>true</code> if the portlet does not share session
706            attributes with the portal
707            */
708            public boolean getPrivateSessionAttributes();
709    
710            /**
711            * Returns the supported processing event from a namespace URI and a local
712            * part.
713            *
714            * @param uri the namespace URI
715            * @param localPart the local part
716            * @return the supported processing event from a namespace URI and a local
717            part
718            */
719            public com.liferay.portal.kernel.xml.QName getProcessingEvent(
720                    java.lang.String uri, java.lang.String localPart);
721    
722            /**
723            * Returns the supported processing events of the portlet.
724            *
725            * @return supported processing events of the portlet
726            */
727            public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
728    
729            /**
730            * Returns the supported public render parameter from an identifier.
731            *
732            * @param identifier the identifier
733            * @return the supported public render parameter from an identifier
734            */
735            public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
736                    java.lang.String identifier);
737    
738            /**
739            * Returns the supported public render parameter from a namespace URI and a
740            * local part.
741            *
742            * @param uri the namespace URI
743            * @param localPart the local part
744            * @return the supported public render parameter from a namespace URI and a
745            local part
746            */
747            public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
748                    java.lang.String uri, java.lang.String localPart);
749    
750            /**
751            * Returns the supported public render parameters of the portlet.
752            *
753            * @return the supported public render parameters of the portlet
754            */
755            public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
756    
757            /**
758            * Returns the supported publishing events of the portlet.
759            *
760            * @return supported publishing events of the portlet
761            */
762            public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
763    
764            /**
765            * Returns <code>true</code> if the portlet is ready to be used.
766            *
767            * @return <code>true</code> if the portlet is ready to be used
768            */
769            public boolean getReady();
770    
771            /**
772            * Returns <code>true</code> if the portlet supports remoting.
773            *
774            * @return <code>true</code> if the portlet supports remoting
775            */
776            public boolean getRemoteable();
777    
778            /**
779            * Returns the render timeout of the portlet.
780            *
781            * @return the render timeout of the portlet
782            */
783            public int getRenderTimeout();
784    
785            /**
786            * Returns the render weight of the portlet.
787            *
788            * @return the render weight of the portlet
789            */
790            public int getRenderWeight();
791    
792            /**
793            * Returns the resource bundle of the portlet.
794            *
795            * @return resource bundle of the portlet
796            */
797            public java.lang.String getResourceBundle();
798    
799            /**
800            * Returns <code>true</code> if the portlet restores to the current view
801            * from the maximized state.
802            *
803            * @return <code>true</code> if the portlet restores to the current view
804            from the maximized state
805            */
806            public boolean getRestoreCurrentView();
807    
808            /**
809            * Returns the role mappers of the portlet.
810            *
811            * @return role mappers of the portlet
812            */
813            public java.util.Map<java.lang.String, java.lang.String> getRoleMappers();
814    
815            /**
816            * Returns an array of required roles of the portlet.
817            *
818            * @return an array of required roles of the portlet
819            */
820            public java.lang.String[] getRolesArray();
821    
822            /**
823            * Returns the root portlet of this portlet instance.
824            *
825            * @return the root portlet of this portlet instance
826            */
827            public com.liferay.portal.model.Portlet getRootPortlet();
828    
829            /**
830            * Returns the root portlet ID of the portlet.
831            *
832            * @return the root portlet ID of the portlet
833            */
834            public java.lang.String getRootPortletId();
835    
836            /**
837            * Returns the scheduler entries of the portlet.
838            *
839            * @return the scheduler entries of the portlet
840            */
841            public java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries();
842    
843            /**
844            * Returns <code>true</code> if the portlet supports scoping of data.
845            *
846            * @return <code>true</code> if the portlet supports scoping of data
847            */
848            public boolean getScopeable();
849    
850            /**
851            * Returns <code>true</code> if users are shown that they do not have access
852            * to the portlet.
853            *
854            * @return <code>true</code> if users are shown that they do not have access
855            to the portlet
856            */
857            public boolean getShowPortletAccessDenied();
858    
859            /**
860            * Returns <code>true</code> if users are shown that the portlet is
861            * inactive.
862            *
863            * @return <code>true</code> if users are shown that the portlet is inactive
864            */
865            public boolean getShowPortletInactive();
866    
867            /**
868            * Returns the names of the classes that represent social activity
869            * interpreters associated with the portlet.
870            *
871            * @return the names of the classes that represent social activity
872            interpreters associated with the portlet
873            */
874            public java.util.List<java.lang.String> getSocialActivityInterpreterClasses();
875    
876            /**
877            * Returns the social activity interpreter instances of the portlet.
878            *
879            * @return the social activity interpreter instances of the portlet
880            */
881            public java.util.List<com.liferay.portlet.social.model.SocialActivityInterpreter> getSocialActivityInterpreterInstances();
882    
883            /**
884            * Returns the name of the social request interpreter class of the portlet.
885            *
886            * @return the name of the social request interpreter class of the portlet
887            */
888            public java.lang.String getSocialRequestInterpreterClass();
889    
890            /**
891            * Returns the name of the social request interpreter instance of the
892            * portlet.
893            *
894            * @return the name of the social request interpreter instance of the
895            portlet
896            */
897            public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
898    
899            /**
900            * Returns the names of the classes that represent staged model data
901            * handlers associated with the portlet.
902            *
903            * @return the names of the classes that represent staged model data
904            handlers associated with the portlet
905            */
906            public java.util.List<java.lang.String> getStagedModelDataHandlerClasses();
907    
908            /**
909            * Returns the staged model data handler instances of the portlet.
910            *
911            * @return the staged model data handler instances of the portlet
912            */
913            public java.util.List<com.liferay.portal.kernel.lar.StagedModelDataHandler<?>> getStagedModelDataHandlerInstances();
914    
915            /**
916            * Returns <code>true</code> if the portlet is a static portlet that is
917            * cannot be moved.
918            *
919            * @return <code>true</code> if the portlet is a static portlet that is
920            cannot be moved
921            */
922            public boolean getStatic();
923    
924            /**
925            * Returns <code>true</code> if the portlet is a static portlet at the end
926            * of a list of portlets.
927            *
928            * @return <code>true</code> if the portlet is a static portlet at the end
929            of a list of portlets
930            */
931            public boolean getStaticEnd();
932    
933            /**
934            * Returns the path for static resources served by this portlet.
935            *
936            * @return the path for static resources served by this portlet
937            */
938            public java.lang.String getStaticResourcePath();
939    
940            /**
941            * Returns <code>true</code> if the portlet is a static portlet at the start
942            * of a list of portlets.
943            *
944            * @return <code>true</code> if the portlet is a static portlet at the start
945            of a list of portlets
946            */
947            public boolean getStaticStart();
948    
949            /**
950            * Returns the struts path of the portlet.
951            *
952            * @return the struts path of the portlet
953            */
954            public java.lang.String getStrutsPath();
955    
956            /**
957            * Returns the supported locales of the portlet.
958            *
959            * @return supported locales of the portlet
960            */
961            public java.util.Set<java.lang.String> getSupportedLocales();
962    
963            /**
964            * Returns <code>true</code> if the portlet is a system portlet that a user
965            * cannot manually add to their page.
966            *
967            * @return <code>true</code> if the portlet is a system portlet that a user
968            cannot manually add to their page
969            */
970            public boolean getSystem();
971    
972            /**
973            * Returns the name of the template handler class of the portlet.
974            *
975            * @return the name of the template handler class of the portlet
976            */
977            public java.lang.String getTemplateHandlerClass();
978    
979            /**
980            * Returns the template handler instance of the portlet.
981            *
982            * @return the template handler instance of the portlet
983            */
984            public com.liferay.portal.kernel.template.TemplateHandler getTemplateHandlerInstance();
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 filters of the portlet.
1820            *
1821            * @param portletFilters the filters of the portlet
1822            */
1823            public void setPortletFilters(
1824                    java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> portletFilters);
1825    
1826            /**
1827            * Sets the portlet info of the portlet.
1828            *
1829            * @param portletInfo the portlet info of the portlet
1830            */
1831            public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
1832    
1833            /**
1834            * Sets the name of the portlet layout listener class of the portlet.
1835            *
1836            * @param portletLayoutListenerClass the name of the portlet layout listener
1837            class of the portlet
1838            */
1839            public void setPortletLayoutListenerClass(
1840                    java.lang.String portletLayoutListenerClass);
1841    
1842            /**
1843            * Sets the portlet modes of the portlet.
1844            *
1845            * @param portletModes the portlet modes of the portlet
1846            */
1847            public void setPortletModes(
1848                    java.util.Map<java.lang.String, java.util.Set<java.lang.String>> portletModes);
1849    
1850            /**
1851            * Sets the name of the portlet.
1852            *
1853            * @param portletName the name of the portlet
1854            */
1855            public void setPortletName(java.lang.String portletName);
1856    
1857            /**
1858            * Sets the name of the portlet URL class of the portlet.
1859            *
1860            * @param portletURLClass the name of the portlet URL class of the portlet
1861            */
1862            public void setPortletURLClass(java.lang.String portletURLClass);
1863    
1864            /**
1865            * Set to <code>true</code> if preferences are shared across the entire
1866            * company.
1867            *
1868            * @param preferencesCompanyWide boolean value for whether preferences are
1869            shared across the entire company
1870            */
1871            public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
1872    
1873            /**
1874            * Set to <code>true</code> if preferences are owned by the group when the
1875            * portlet is shown in a group layout. Set to <code>false</code> if
1876            * preferences are owned by the user at all times.
1877            *
1878            * @param preferencesOwnedByGroup boolean value for whether preferences are
1879            owned by the group when the portlet is shown in a group layout or
1880            preferences are owned by the user at all times
1881            */
1882            public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
1883    
1884            /**
1885            * Set to <code>true</code> if preferences are unique per layout.
1886            *
1887            * @param preferencesUniquePerLayout boolean value for whether preferences
1888            are unique per layout
1889            */
1890            public void setPreferencesUniquePerLayout(
1891                    boolean preferencesUniquePerLayout);
1892    
1893            /**
1894            * Sets the name of the preferences validator class of the portlet.
1895            *
1896            * @param preferencesValidator the name of the preferences validator class
1897            of the portlet
1898            */
1899            public void setPreferencesValidator(java.lang.String preferencesValidator);
1900    
1901            /**
1902            * Set to <code>true</code> if the portlet does not share request attributes
1903            * with the portal or portlets from another WAR.
1904            *
1905            * @param privateRequestAttributes boolean value for whether the portlet
1906            shares request attributes with the portal or portlets from another
1907            WAR
1908            */
1909            public void setPrivateRequestAttributes(boolean privateRequestAttributes);
1910    
1911            /**
1912            * Set to <code>true</code> if the portlet does not share session attributes
1913            * with the portal.
1914            *
1915            * @param privateSessionAttributes boolean value for whether the portlet
1916            shares session attributes with the portal
1917            */
1918            public void setPrivateSessionAttributes(boolean privateSessionAttributes);
1919    
1920            /**
1921            * Sets the supported processing events of the portlet.
1922            *
1923            * @param processingEvents the supported processing events of the portlet
1924            */
1925            public void setProcessingEvents(
1926                    java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
1927    
1928            /**
1929            * Sets the supported public render parameters of the portlet.
1930            *
1931            * @param publicRenderParameters the supported public render parameters of
1932            the portlet
1933            */
1934            public void setPublicRenderParameters(
1935                    java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
1936    
1937            /**
1938            * Sets the supported publishing events of the portlet.
1939            *
1940            * @param publishingEvents the supported publishing events of the portlet
1941            */
1942            public void setPublishingEvents(
1943                    java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
1944    
1945            /**
1946            * Set to <code>true</code> if the portlet is ready to be used.
1947            *
1948            * @param ready whether the portlet is ready to be used
1949            */
1950            public void setReady(boolean ready);
1951    
1952            /**
1953            * Set to <code>true</code> if the portlet supports remoting
1954            *
1955            * @param remoteable boolean value for whether or not the the portlet
1956            supports remoting
1957            */
1958            public void setRemoteable(boolean remoteable);
1959    
1960            /**
1961            * Sets the render timeout of the portlet.
1962            *
1963            * @param renderTimeout the render timeout of the portlet
1964            */
1965            public void setRenderTimeout(int renderTimeout);
1966    
1967            /**
1968            * Sets the render weight of the portlet.
1969            *
1970            * @param renderWeight int value for the render weight of the portlet
1971            */
1972            public void setRenderWeight(int renderWeight);
1973    
1974            /**
1975            * Sets the resource bundle of the portlet.
1976            *
1977            * @param resourceBundle the resource bundle of the portlet
1978            */
1979            public void setResourceBundle(java.lang.String resourceBundle);
1980    
1981            /**
1982            * Set to <code>true</code> if the portlet restores to the current view from
1983            * the maximized state.
1984            *
1985            * @param restoreCurrentView boolean value for whether the portlet restores
1986            to the current view from the maximized state
1987            */
1988            public void setRestoreCurrentView(boolean restoreCurrentView);
1989    
1990            /**
1991            * Sets the role mappers of the portlet.
1992            *
1993            * @param roleMappers the role mappers of the portlet
1994            */
1995            public void setRoleMappers(
1996                    java.util.Map<java.lang.String, java.lang.String> roleMappers);
1997    
1998            /**
1999            * Sets a string of ordered comma delimited portlet IDs.
2000            *
2001            * @param roles a string of ordered comma delimited portlet IDs
2002            */
2003            public void setRoles(java.lang.String roles);
2004    
2005            /**
2006            * Sets an array of required roles of the portlet.
2007            *
2008            * @param rolesArray an array of required roles of the portlet
2009            */
2010            public void setRolesArray(java.lang.String[] rolesArray);
2011    
2012            /**
2013            * Sets the scheduler entries of the portlet.
2014            *
2015            * @param schedulerEntries the scheduler entries of the portlet
2016            */
2017            public void setSchedulerEntries(
2018                    java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries);
2019    
2020            /**
2021            * Set to <code>true</code> if the portlet supports scoping of data.
2022            *
2023            * @param scopeable boolean value for whether or not the the portlet
2024            supports scoping of data
2025            */
2026            public void setScopeable(boolean scopeable);
2027    
2028            /**
2029            * Set to <code>true</code> if users are shown that they do not have access
2030            * to the portlet.
2031            *
2032            * @param showPortletAccessDenied boolean value for whether users are shown
2033            that they do not have access to the portlet
2034            */
2035            public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
2036    
2037            /**
2038            * Set to <code>true</code> if users are shown that the portlet is inactive.
2039            *
2040            * @param showPortletInactive boolean value for whether users are shown that
2041            the portlet is inactive
2042            */
2043            public void setShowPortletInactive(boolean showPortletInactive);
2044    
2045            /**
2046            * Sets the names of the classes that represent social activity interpreters
2047            * associated with the portlet.
2048            *
2049            * @param socialActivityInterpreterClasses the names of the classes that
2050            represent social activity interpreters associated with the portlet
2051            */
2052            public void setSocialActivityInterpreterClasses(
2053                    java.util.List<java.lang.String> socialActivityInterpreterClasses);
2054    
2055            /**
2056            * Sets the name of the social request interpreter class of the portlet.
2057            *
2058            * @param socialRequestInterpreterClass the name of the request interpreter
2059            class of the portlet
2060            */
2061            public void setSocialRequestInterpreterClass(
2062                    java.lang.String socialRequestInterpreterClass);
2063    
2064            /**
2065            * Sets the names of the classes that represent staged model data handlers
2066            * associated with the portlet.
2067            *
2068            * @param stagedModelDataHandlerClasses the names of the classes that
2069            represent staged model data handlers associated with the portlet
2070            */
2071            public void setStagedModelDataHandlerClasses(
2072                    java.util.List<java.lang.String> stagedModelDataHandlerClasses);
2073    
2074            /**
2075            * Set to <code>true</code> if the portlet is a static portlet that is
2076            * cannot be moved.
2077            *
2078            * @param staticPortlet boolean value for whether the portlet is a static
2079            portlet that cannot be moved
2080            */
2081            public void setStatic(boolean staticPortlet);
2082    
2083            /**
2084            * Set to <code>true</code> if the portlet is a static portlet at the start
2085            * of a list of portlets.
2086            *
2087            * @param staticPortletStart boolean value for whether the portlet is a
2088            static portlet at the start of a list of portlets
2089            */
2090            public void setStaticStart(boolean staticPortletStart);
2091    
2092            /**
2093            * Sets the struts path of the portlet.
2094            *
2095            * @param strutsPath the struts path of the portlet
2096            */
2097            public void setStrutsPath(java.lang.String strutsPath);
2098    
2099            /**
2100            * Sets the supported locales of the portlet.
2101            *
2102            * @param supportedLocales the supported locales of the portlet
2103            */
2104            public void setSupportedLocales(
2105                    java.util.Set<java.lang.String> supportedLocales);
2106    
2107            /**
2108            * Set to <code>true</code> if the portlet is a system portlet that a user
2109            * cannot manually add to their page.
2110            *
2111            * @param system boolean value for whether the portlet is a system portlet
2112            that a user cannot manually add to their page
2113            */
2114            public void setSystem(boolean system);
2115    
2116            /**
2117            * Sets the name of the template handler class of the portlet.
2118            *
2119            * @param templateHandlerClass the name of template handler class of the
2120            portlet
2121            */
2122            public void setTemplateHandlerClass(java.lang.String templateHandlerClass);
2123    
2124            /**
2125            * Sets the timestamp of the portlet.
2126            *
2127            * @param timestamp the timestamp of the portlet
2128            */
2129            public void setTimestamp(long timestamp);
2130    
2131            /**
2132            * Sets the names of the classes that represent trash handlers associated to
2133            * the portlet.
2134            *
2135            * @param trashHandlerClasses the names of the classes that represent trash
2136            handlers associated with the portlet
2137            */
2138            public void setTrashHandlerClasses(
2139                    java.util.List<java.lang.String> trashHandlerClasses);
2140    
2141            /**
2142            * Set to <code>true</code> if the portlet is an undeployed portlet.
2143            *
2144            * @param undeployedPortlet boolean value for whether the portlet is an
2145            undeployed portlet
2146            */
2147            public void setUndeployedPortlet(boolean undeployedPortlet);
2148    
2149            /**
2150            * Sets the unlinked roles of the portlet.
2151            *
2152            * @param unlinkedRoles the unlinked roles of the portlet
2153            */
2154            public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles);
2155    
2156            /**
2157            * Sets the name of the URL encoder class of the portlet.
2158            *
2159            * @param urlEncoderClass the name of the URL encoder class of the portlet
2160            */
2161            public void setURLEncoderClass(java.lang.String urlEncoderClass);
2162    
2163            /**
2164            * Set to <code>true</code> if the portlet uses the default template.
2165            *
2166            * @param useDefaultTemplate boolean value for whether the portlet uses the
2167            default template
2168            */
2169            public void setUseDefaultTemplate(boolean useDefaultTemplate);
2170    
2171            /**
2172            * Sets the user principal strategy of the portlet.
2173            *
2174            * @param userPrincipalStrategy the user principal strategy of the portlet
2175            */
2176            public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
2177    
2178            /**
2179            * Sets the virtual path of the portlet.
2180            *
2181            * @param virtualPath the virtual path of the portlet
2182            */
2183            public void setVirtualPath(java.lang.String virtualPath);
2184    
2185            /**
2186            * Sets the name of the WebDAV storage class of the portlet.
2187            *
2188            * @param webDAVStorageClass the name of the WebDAV storage class of the
2189            portlet
2190            */
2191            public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
2192    
2193            /**
2194            * Sets the name of the WebDAV storage token of the portlet.
2195            *
2196            * @param webDAVStorageToken the name of the WebDAV storage token of the
2197            portlet
2198            */
2199            public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
2200    
2201            /**
2202            * Sets the window states of the portlet.
2203            *
2204            * @param windowStates the window states of the portlet
2205            */
2206            public void setWindowStates(
2207                    java.util.Map<java.lang.String, java.util.Set<java.lang.String>> windowStates);
2208    
2209            /**
2210            * Sets the names of the classes that represent workflow handlers associated
2211            * to the portlet.
2212            *
2213            * @param workflowHandlerClasses the names of the classes that represent
2214            workflow handlers associated with the portlet
2215            */
2216            public void setWorkflowHandlerClasses(
2217                    java.util.List<java.lang.String> workflowHandlerClasses);
2218    
2219            /**
2220            * Sets the name of the XML-RPC method class of the portlet.
2221            *
2222            * @param xmlRpcMethodClass the name of the XML-RPC method class of the
2223            portlet
2224            */
2225            public void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass);
2226    }