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