| Portlet.java |
1 /**
2 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3 *
4 * The contents of this file are subject to the terms of the Liferay Enterprise
5 * Subscription License ("License"). You may not use this file except in
6 * compliance with the License. You can obtain a copy of the License by
7 * contacting Liferay, Inc. See the License for the specific language governing
8 * permissions and limitations under the License, including but not limited to
9 * distribution rights of the Software.
10 *
11 *
12 *
13 */
14
15 package com.liferay.portal.model;
16
17 /**
18 * <a href="Portlet.java.html"><b><i>View Source</i></b></a>
19 *
20 * <p>
21 * ServiceBuilder generated this class. Modifications in this class will be
22 * overwritten the next time is generated.
23 * </p>
24 *
25 * <p>
26 * This interface is a model that represents the Portlet table in the
27 * database.
28 * </p>
29 *
30 * <p>
31 * Customize {@link com.liferay.portal.model.impl.PortletImpl} and rerun the
32 * ServiceBuilder to generate the new methods.
33 * </p>
34 *
35 * @author Brian Wing Shun Chan
36 * @see PortletModel
37 * @see com.liferay.portal.model.impl.PortletImpl
38 * @see com.liferay.portal.model.impl.PortletModelImpl
39 * @generated
40 */
41 public interface Portlet extends PortletModel {
42 /**
43 * Gets the root portlet id of the portlet.
44 *
45 * @return the root portlet id of the portlet
46 */
47 public java.lang.String getRootPortletId();
48
49 /**
50 * Gets the instance id of the portlet.
51 *
52 * @return the instance id of the portlet
53 */
54 public java.lang.String getInstanceId();
55
56 /**
57 * Gets the plugin id of the portlet.
58 *
59 * @return the plugin id of the portlet
60 */
61 public java.lang.String getPluginId();
62
63 /**
64 * Gets the plugin type of the portlet.
65 *
66 * @return the plugin type of the portlet
67 */
68 public java.lang.String getPluginType();
69
70 /**
71 * Get the package to which the portlet belongs to.
72 *
73 * @return the plugin package of the portlet
74 */
75 public com.liferay.portal.kernel.plugin.PluginPackage getPluginPackage();
76
77 /**
78 * Sets the plugin package this portlet belongs to.
79 *
80 * @param pluginPackage the plugin package
81 */
82 public void setPluginPackage(
83 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
84
85 /**
86 * Get the default plugin settings of the portlet.
87 *
88 * @return the plugin settings
89 */
90 public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
91
92 /**
93 * Sets the default plugin settings of the portlet.
94 *
95 * @param pluginSetting the plugin setting
96 */
97 public void setDefaultPluginSetting(
98 com.liferay.portal.model.PluginSetting pluginSetting);
99
100 /**
101 * Gets the timestamp of the portlet.
102 *
103 * @return the timestamp of the portlet
104 */
105 public long getTimestamp();
106
107 /**
108 * Sets the timestamp of the portlet.
109 *
110 * @param timestamp the timestamp of the portlet
111 */
112 public void setTimestamp(long timestamp);
113
114 /**
115 * Gets the icon of the portlet.
116 *
117 * @return the icon of the portlet
118 */
119 public java.lang.String getIcon();
120
121 /**
122 * Sets the icon of the portlet.
123 *
124 * @param icon the icon of the portlet
125 */
126 public void setIcon(java.lang.String icon);
127
128 /**
129 * Gets the virtual path of the portlet.
130 *
131 * @return the virtual path of the portlet
132 */
133 public java.lang.String getVirtualPath();
134
135 /**
136 * Sets the virtual path of the portlet.
137 *
138 * @param virtualPath the virtual path of the portlet
139 */
140 public void setVirtualPath(java.lang.String virtualPath);
141
142 /**
143 * Gets the struts path of the portlet.
144 *
145 * @return the struts path of the portlet
146 */
147 public java.lang.String getStrutsPath();
148
149 /**
150 * Sets the struts path of the portlet.
151 *
152 * @param strutsPath the struts path of the portlet
153 */
154 public void setStrutsPath(java.lang.String strutsPath);
155
156 /**
157 * Gets the name of the portlet.
158 *
159 * @return the display name of the portlet
160 */
161 public java.lang.String getPortletName();
162
163 /**
164 * Sets the name of the portlet.
165 *
166 * @param portletName the name of the portlet
167 */
168 public void setPortletName(java.lang.String portletName);
169
170 /**
171 * Gets the display name of the portlet.
172 *
173 * @return the display name of the portlet
174 */
175 public java.lang.String getDisplayName();
176
177 /**
178 * Sets the display name of the portlet.
179 *
180 * @param displayName the display name of the portlet
181 */
182 public void setDisplayName(java.lang.String displayName);
183
184 /**
185 * Gets the name of the portlet class of the portlet.
186 *
187 * @return the name of the portlet class of the portlet
188 */
189 public java.lang.String getPortletClass();
190
191 /**
192 * Sets the name of the portlet class of the portlet.
193 *
194 * @param portletClass the name of the portlet class of the portlet
195 */
196 public void setPortletClass(java.lang.String portletClass);
197
198 /**
199 * Gets the configuration action class of the portlet.
200 *
201 * @return the configuration action class of the portlet
202 */
203 public java.lang.String getConfigurationActionClass();
204
205 /**
206 * Sets the configuration action class of the portlet.
207 *
208 * @param configurationActionClass the configuration action class of the
209 portlet
210 */
211 public void setConfigurationActionClass(
212 java.lang.String configurationActionClass);
213
214 /**
215 * Gets the configuration action instance of the portlet.
216 *
217 * @return the configuration action instance of the portlet
218 */
219 public com.liferay.portal.kernel.portlet.ConfigurationAction getConfigurationActionInstance();
220
221 /**
222 * Gets the name of the indexer class of the portlet.
223 *
224 * @return the name of the indexer class of the portlet
225 */
226 public java.lang.String getIndexerClass();
227
228 /**
229 * Sets the name of the indexer class of the portlet.
230 *
231 * @param indexerClass the name of the indexer class of the portlet
232 */
233 public void setIndexerClass(java.lang.String indexerClass);
234
235 /**
236 * Gets the indexer instance of the portlet.
237 *
238 * @return the indexer instance of the portlet
239 */
240 public com.liferay.portal.kernel.search.Indexer getIndexerInstance();
241
242 /**
243 * Gets the name of the open search class of the portlet.
244 *
245 * @return the name of the open search class of the portlet
246 */
247 public java.lang.String getOpenSearchClass();
248
249 /**
250 * Sets the name of the open search class of the portlet.
251 *
252 * @param openSearchClass the name of the open search class of the portlet
253 */
254 public void setOpenSearchClass(java.lang.String openSearchClass);
255
256 /**
257 * Gets the indexer instance of the portlet.
258 *
259 * @return the indexer instance of the portlet
260 */
261 public com.liferay.portal.kernel.search.OpenSearch getOpenSearchInstance();
262
263 /**
264 * Gets the name of the scheduler class of the portlet.
265 *
266 * @return the name of the scheduler class of the portlet
267 */
268 public java.lang.String getSchedulerClass();
269
270 /**
271 * Sets the name of the scheduler class of the portlet.
272 *
273 * @param schedulerClass the name of the scheduler class of the portlet
274 */
275 public void setSchedulerClass(java.lang.String schedulerClass);
276
277 /**
278 * Gets the scheduler instance of the portlet.
279 *
280 * @return the scheduler instance of the portlet
281 */
282 public com.liferay.portal.kernel.job.Scheduler getSchedulerInstance();
283
284 /**
285 * Gets the name of the portlet URL class of the portlet.
286 *
287 * @return the name of the portlet URL class of the portlet
288 */
289 public java.lang.String getPortletURLClass();
290
291 /**
292 * Sets the name of the portlet URL class of the portlet.
293 *
294 * @param portletURLClass the name of the portlet URL class of the portlet
295 */
296 public void setPortletURLClass(java.lang.String portletURLClass);
297
298 /**
299 * Gets the name of the friendly URL mapper class of the portlet.
300 *
301 * @return the name of the friendly URL mapper class of the portlet
302 */
303 public java.lang.String getFriendlyURLMapperClass();
304
305 /**
306 * Sets the name of the friendly URL mapper class of the portlet.
307 *
308 * @param friendlyURLMapperClass the name of the friendly URL mapper class
309 of the portlet
310 */
311 public void setFriendlyURLMapperClass(
312 java.lang.String friendlyURLMapperClass);
313
314 /**
315 * Gets the friendly URL mapper instance of the portlet.
316 *
317 * @return the friendly URL mapper instance of the portlet
318 */
319 public com.liferay.portal.kernel.portlet.FriendlyURLMapper getFriendlyURLMapperInstance();
320
321 /**
322 * Gets the name of the URL encoder class of the portlet.
323 *
324 * @return the name of the URL encoder class of the portlet
325 */
326 public java.lang.String getURLEncoderClass();
327
328 /**
329 * Sets the name of the URL encoder class of the portlet.
330 *
331 * @param urlEncoderClass the name of the URL encoder class of the portlet
332 */
333 public void setURLEncoderClass(java.lang.String urlEncoderClass);
334
335 /**
336 * Gets the URL encoder instance of the portlet.
337 *
338 * @return the URL encoder instance of the portlet
339 */
340 public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance();
341
342 /**
343 * Gets the name of the portlet data handler class of the portlet.
344 *
345 * @return the name of the portlet data handler class of the portlet
346 */
347 public java.lang.String getPortletDataHandlerClass();
348
349 /**
350 * Sets the name of the portlet data handler class of the portlet.
351 *
352 * @param portletDataHandlerClass the name of portlet data handler class of
353 the portlet
354 */
355 public void setPortletDataHandlerClass(
356 java.lang.String portletDataHandlerClass);
357
358 /**
359 * Gets the portlet data handler instance of the portlet.
360 *
361 * @return the portlet data handler instance of the portlet
362 */
363 public com.liferay.portal.lar.PortletDataHandler getPortletDataHandlerInstance();
364
365 /**
366 * Gets the name of the portlet layout listener class of the portlet.
367 *
368 * @return the name of the portlet layout listener class of the portlet
369 */
370 public java.lang.String getPortletLayoutListenerClass();
371
372 /**
373 * Sets the name of the portlet layout listener class of the portlet.
374 *
375 * @param portletLayoutListenerClass the name of the portlet layout listener
376 class of the portlet
377 */
378 public void setPortletLayoutListenerClass(
379 java.lang.String portletLayoutListenerClass);
380
381 /**
382 * Gets the portlet layout listener instance of the portlet.
383 *
384 * @return the portlet layout listener instance of the portlet
385 */
386 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance();
387
388 /**
389 * Gets the name of the poller processor class of the portlet.
390 *
391 * @return the name of the poller processor class of the portlet
392 */
393 public java.lang.String getPollerProcessorClass();
394
395 /**
396 * Sets the name of the poller processor class of the portlet.
397 *
398 * @param pollerProcessorClass the name of the poller processor class of the
399 portlet
400 */
401 public void setPollerProcessorClass(java.lang.String pollerProcessorClass);
402
403 /**
404 * Gets the poller processor instance of the portlet.
405 *
406 * @return the poller processor instance of the portlet
407 */
408 public com.liferay.portal.kernel.poller.PollerProcessor getPollerProcessorInstance();
409
410 /**
411 * Gets the name of the POP message listener class of the portlet.
412 *
413 * @return the name of the POP message listener class of the portlet
414 */
415 public java.lang.String getPopMessageListenerClass();
416
417 /**
418 * Sets the name of the POP message listener class of the portlet.
419 *
420 * @param popMessageListenerClass the name of the POP message listener class
421 of the portlet
422 */
423 public void setPopMessageListenerClass(
424 java.lang.String popMessageListenerClass);
425
426 /**
427 * Gets the POP message listener instance of the portlet.
428 *
429 * @return the POP message listener instance of the portlet
430 */
431 public com.liferay.portal.kernel.pop.MessageListener getPopMessageListenerInstance();
432
433 /**
434 * Gets the name of the social activity interpreter class of the portlet.
435 *
436 * @return the name of the social activity interpreter class of the portlet
437 */
438 public java.lang.String getSocialActivityInterpreterClass();
439
440 /**
441 * Sets the name of the social activity interpreter class of the portlet.
442 *
443 * @param socialActivityInterpreterClass the name of the activity
444 interpreter class of the portlet
445 */
446 public void setSocialActivityInterpreterClass(
447 java.lang.String socialActivityInterpreterClass);
448
449 /**
450 * Gets the name of the social activity interpreter instance of the portlet.
451 *
452 * @return the name of the social activity interpreter instance of the
453 portlet
454 */
455 public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance();
456
457 /**
458 * Gets the name of the social request interpreter class of the portlet.
459 *
460 * @return the name of the social request interpreter class of the portlet
461 */
462 public java.lang.String getSocialRequestInterpreterClass();
463
464 /**
465 * Sets the name of the social request interpreter class of the portlet.
466 *
467 * @param socialRequestInterpreterClass the name of the request interpreter
468 class of the portlet
469 */
470 public void setSocialRequestInterpreterClass(
471 java.lang.String socialRequestInterpreterClass);
472
473 /**
474 * Gets the name of the social request interpreter instance of the portlet.
475 *
476 * @return the name of the social request interpreter instance of the
477 portlet
478 */
479 public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance();
480
481 /**
482 * Gets the name of the WebDAV storage token of the portlet.
483 *
484 * @return the name of the WebDAV storage token of the portlet
485 */
486 public java.lang.String getWebDAVStorageToken();
487
488 /**
489 * Sets the name of the WebDAV storage token of the portlet.
490 *
491 * @param webDAVStorageToken the name of the WebDAV storage token of the
492 portlet
493 */
494 public void setWebDAVStorageToken(java.lang.String webDAVStorageToken);
495
496 /**
497 * Gets the name of the WebDAV storage class of the portlet.
498 *
499 * @return the name of the WebDAV storage class of the portlet
500 */
501 public java.lang.String getWebDAVStorageClass();
502
503 /**
504 * Sets the name of the WebDAV storage class of the portlet.
505 *
506 * @param webDAVStorageClass the name of the WebDAV storage class of the
507 portlet
508 */
509 public void setWebDAVStorageClass(java.lang.String webDAVStorageClass);
510
511 /**
512 * Gets the name of the WebDAV storage instance of the portlet.
513 *
514 * @return the name of the WebDAV storage instance of the portlet
515 */
516 public com.liferay.portal.webdav.WebDAVStorage getWebDAVStorageInstance();
517
518 /**
519 * Gets the name of the category of the Control Panel where the portlet will
520 * be shown.
521 *
522 * @return the name of of the category of the Control Panel where the
523 portlet will be shown
524 */
525 public java.lang.String getControlPanelEntryCategory();
526
527 /**
528 * Set the name of the category of the Control Panel where the portlet will
529 * be shown.
530 *
531 * @param controlPanelEntryCategory the name of the category of the Control
532 Panel where the portlet will be shown
533 */
534 public void setControlPanelEntryCategory(
535 java.lang.String controlPanelEntryCategory);
536
537 /**
538 * Gets the relative weight of the portlet with respect to the other
539 * portlets in the same category of the Control Panel.
540 *
541 * @return the relative weight of the portlet with respect to the other
542 portlets in the same category of the Control Panel
543 */
544 public double getControlPanelEntryWeight();
545
546 /**
547 * Sets the relative weight of the portlet with respect to the other
548 * portlets in the same category of the Control Panel.
549 *
550 * @param controlPanelEntryWeight the relative weight of the portlet with
551 respect to the other portlets in the same category of the Control
552 Panel
553 */
554 public void setControlPanelEntryWeight(double controlPanelEntryWeight);
555
556 /**
557 * Gets the name of the class that will control when the portlet will be
558 * shown in the Control Panel.
559 *
560 * @return the name of the class that will control when the portlet will be
561 shown in the Control Panel
562 */
563 public java.lang.String getControlPanelEntryClass();
564
565 /**
566 * Sets the name of the class that will control when the portlet will be
567 * shown in the Control Panel.
568 *
569 * @param controlPanelEntryClass the name of the class that will control
570 when the portlet will be shown in the Control Panel
571 */
572 public void setControlPanelEntryClass(
573 java.lang.String controlPanelEntryClass);
574
575 /**
576 * Gets an instance of the class that will control when the portlet will be
577 * shown in the Control Panel.
578 *
579 * @return the instance of the class that will control when the portlet will
580 be shown in the Control Panel
581 */
582 public com.liferay.portlet.ControlPanelEntry getControlPanelEntryInstance();
583
584 /**
585 * Gets the default preferences of the portlet.
586 *
587 * @return the default preferences of the portlet
588 */
589 public java.lang.String getDefaultPreferences();
590
591 /**
592 * Sets the default preferences of the portlet.
593 *
594 * @param defaultPreferences the default preferences of the portlet
595 */
596 public void setDefaultPreferences(java.lang.String defaultPreferences);
597
598 /**
599 * Gets the name of the preferences validator class of the portlet.
600 *
601 * @return the name of the preferences validator class of the portlet
602 */
603 public java.lang.String getPreferencesValidator();
604
605 /**
606 * Sets the name of the preferences validator class of the portlet.
607 *
608 * @param preferencesValidator the name of the preferences validator class
609 of the portlet
610 */
611 public void setPreferencesValidator(java.lang.String preferencesValidator);
612
613 /**
614 * Returns true if preferences are shared across the entire company.
615 *
616 * @return true if preferences are shared across the entire company
617 */
618 public boolean getPreferencesCompanyWide();
619
620 /**
621 * Returns true if preferences are shared across the entire company.
622 *
623 * @return true if preferences are shared across the entire company
624 */
625 public boolean isPreferencesCompanyWide();
626
627 /**
628 * Set to true if preferences are shared across the entire company.
629 *
630 * @param preferencesCompanyWide boolean value for whether preferences are
631 shared across the entire company
632 */
633 public void setPreferencesCompanyWide(boolean preferencesCompanyWide);
634
635 /**
636 * Returns true if preferences are unique per layout.
637 *
638 * @return true if preferences are unique per layout
639 */
640 public boolean getPreferencesUniquePerLayout();
641
642 /**
643 * Returns true if preferences are unique per layout.
644 *
645 * @return true if preferences are unique per layout
646 */
647 public boolean isPreferencesUniquePerLayout();
648
649 /**
650 * Set to true if preferences are unique per layout.
651 *
652 * @param preferencesUniquePerLayout boolean value for whether preferences
653 are unique per layout
654 */
655 public void setPreferencesUniquePerLayout(
656 boolean preferencesUniquePerLayout);
657
658 /**
659 * Returns true if preferences are owned by the group when the portlet is
660 * shown in a group layout. Returns false if preferences are owned by the
661 * user at all times.
662 *
663 * @return true if preferences are owned by the group when the portlet is
664 shown in a group layout; false if preferences are owned by the
665 user at all times.
666 */
667 public boolean getPreferencesOwnedByGroup();
668
669 /**
670 * Returns true if preferences are owned by the group when the portlet is
671 * shown in a group layout. Returns false if preferences are owned by the
672 * user at all times.
673 *
674 * @return true if preferences are owned by the group when the portlet is
675 shown in a group layout; false if preferences are owned by the
676 user at all times.
677 */
678 public boolean isPreferencesOwnedByGroup();
679
680 /**
681 * Set to true if preferences are owned by the group when the portlet is
682 * shown in a group layout. Set to false if preferences are owned by the
683 * user at all times.
684 *
685 * @param preferencesOwnedByGroup boolean value for whether preferences are
686 owned by the group when the portlet is shown in a group layout or
687 preferences are owned by the user at all times
688 */
689 public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup);
690
691 /**
692 * Returns true if the portlet uses the default template.
693 *
694 * @return true if the portlet uses the default template
695 */
696 public boolean getUseDefaultTemplate();
697
698 /**
699 * Returns true if the portlet uses the default template.
700 *
701 * @return true if the portlet uses the default template
702 */
703 public boolean isUseDefaultTemplate();
704
705 /**
706 * Set to true if the portlet uses the default template.
707 *
708 * @param useDefaultTemplate boolean value for whether the portlet uses the
709 default template
710 */
711 public void setUseDefaultTemplate(boolean useDefaultTemplate);
712
713 /**
714 * Returns true if users are shown that they do not have access to the
715 * portlet.
716 *
717 * @return true if users are shown that they do not have access to the
718 portlet
719 */
720 public boolean getShowPortletAccessDenied();
721
722 /**
723 * Returns true if users are shown that they do not have access to the
724 * portlet.
725 *
726 * @return true if users are shown that they do not have access to the
727 portlet
728 */
729 public boolean isShowPortletAccessDenied();
730
731 /**
732 * Set to true if users are shown that they do not have access to the
733 * portlet.
734 *
735 * @param showPortletAccessDenied boolean value for whether users are shown
736 that they do not have access to the portlet
737 */
738 public void setShowPortletAccessDenied(boolean showPortletAccessDenied);
739
740 /**
741 * Returns true if users are shown that the portlet is inactive.
742 *
743 * @return true if users are shown that the portlet is inactive
744 */
745 public boolean getShowPortletInactive();
746
747 /**
748 * Returns true if users are shown that the portlet is inactive.
749 *
750 * @return true if users are shown that the portlet is inactive
751 */
752 public boolean isShowPortletInactive();
753
754 /**
755 * Set to true if users are shown that the portlet is inactive.
756 *
757 * @param showPortletInactive boolean value for whether users are shown that
758 the portlet is inactive
759 */
760 public void setShowPortletInactive(boolean showPortletInactive);
761
762 /**
763 * Returns true if an action URL for this portlet should cause an auto
764 * redirect.
765 *
766 * @return true if an action URL for this portlet should cause an auto
767 redirect
768 */
769 public boolean getActionURLRedirect();
770
771 /**
772 * Returns true if an action URL for this portlet should cause an auto
773 * redirect.
774 *
775 * @return true if an action URL for this portlet should cause an auto
776 redirect
777 */
778 public boolean isActionURLRedirect();
779
780 /**
781 * Set to true if an action URL for this portlet should cause an auto
782 * redirect.
783 *
784 * @param actionURLRedirect boolean value for whether an action URL for this
785 portlet should cause an auto redirect
786 */
787 public void setActionURLRedirect(boolean actionURLRedirect);
788
789 /**
790 * Returns true if the portlet restores to the current view from the
791 * maximized state.
792 *
793 * @return true if the portlet restores to the current view from the
794 maximized state
795 */
796 public boolean getRestoreCurrentView();
797
798 /**
799 * Returns true if the portlet restores to the current view from the
800 * maximized state.
801 *
802 * @return true if the portlet restores to the current view from the
803 maximized state
804 */
805 public boolean isRestoreCurrentView();
806
807 /**
808 * Set to true if the portlet restores to the current view from the
809 * maximized state.
810 *
811 * @param restoreCurrentView boolean value for whether the portlet restores
812 to the current view from the maximized state
813 */
814 public void setRestoreCurrentView(boolean restoreCurrentView);
815
816 /**
817 * Returns true if the portlet goes into the maximized state when the user
818 * goes into the edit mode.
819 *
820 * @return true if the portlet goes into the maximized state when the user
821 goes into the edit mode
822 */
823 public boolean getMaximizeEdit();
824
825 /**
826 * Returns true if the portlet goes into the maximized state when the user
827 * goes into the edit mode.
828 *
829 * @return true if the portlet goes into the maximized state when the user
830 goes into the edit mode
831 */
832 public boolean isMaximizeEdit();
833
834 /**
835 * Set to true if the portlet goes into the maximized state when the user
836 * goes into the edit mode.
837 *
838 * @param maximizeEdit boolean value for whether the portlet goes into the
839 maximized state when the user goes into the edit mode
840 */
841 public void setMaximizeEdit(boolean maximizeEdit);
842
843 /**
844 * Returns true if the portlet goes into the maximized state when the user
845 * goes into the help mode.
846 *
847 * @return true if the portlet goes into the maximized state when the user
848 goes into the help mode
849 */
850 public boolean getMaximizeHelp();
851
852 /**
853 * Returns true if the portlet goes into the maximized state when the user
854 * goes into the help mode.
855 *
856 * @return true if the portlet goes into the maximized state when the user
857 goes into the help mode
858 */
859 public boolean isMaximizeHelp();
860
861 /**
862 * Set to true if the portlet goes into the maximized state when the user
863 * goes into the help mode.
864 *
865 * @param maximizeHelp boolean value for whether the portlet goes into the
866 maximized state when the user goes into the help mode
867 */
868 public void setMaximizeHelp(boolean maximizeHelp);
869
870 /**
871 * Returns true if the portlet goes into the pop up state when the user goes
872 * into the print mode.
873 *
874 * @return true if the portlet goes into the pop up state when the user goes
875 into the print mode
876 */
877 public boolean getPopUpPrint();
878
879 /**
880 * Returns true if the portlet goes into the pop up state when the user goes
881 * into the print mode.
882 *
883 * @return true if the portlet goes into the pop up state when the user goes
884 into the print mode
885 */
886 public boolean isPopUpPrint();
887
888 /**
889 * Set to true if the portlet goes into the pop up state when the user goes
890 * into the print mode.
891 *
892 * @param popUpPrint boolean value for whether the portlet goes into the pop
893 up state when the user goes into the print mode
894 */
895 public void setPopUpPrint(boolean popUpPrint);
896
897 /**
898 * Returns true to allow the portlet to be cached within the layout.
899 *
900 * @return true if the portlet can be cached within the layout
901 */
902 public boolean getLayoutCacheable();
903
904 /**
905 * Returns true to allow the portlet to be cached within the layout.
906 *
907 * @return true if the portlet can be cached within the layout
908 */
909 public boolean isLayoutCacheable();
910
911 /**
912 * Set to true to allow the portlet to be cached within the layout.
913 *
914 * @param layoutCacheable boolean value for whether the portlet can be
915 cached within the layout
916 */
917 public void setLayoutCacheable(boolean layoutCacheable);
918
919 /**
920 * Returns true if the portlet can be added multiple times to a layout.
921 *
922 * @return true if the portlet can be added multiple times to a layout
923 */
924 public boolean getInstanceable();
925
926 /**
927 * Returns true if the portlet can be added multiple times to a layout.
928 *
929 * @return true if the portlet can be added multiple times to a layout
930 */
931 public boolean isInstanceable();
932
933 /**
934 * Set to true if the portlet can be added multiple times to a layout.
935 *
936 * @param instanceable boolean value for whether the portlet can be added
937 multiple times to a layout
938 */
939 public void setInstanceable(boolean instanceable);
940
941 /**
942 * Returns true if the portlet supports scoping of data.
943 *
944 * @return true if the portlet supports scoping of data
945 */
946 public boolean getScopeable();
947
948 /**
949 * Returns true if the portlet supports scoping of data.
950 *
951 * @return true if the portlet supports scoping of data
952 */
953 public boolean isScopeable();
954
955 /**
956 * Set to true if the portlet supports scoping of data.
957 *
958 * @param scopeable boolean value for whether or not the the portlet
959 supports scoping of data
960 */
961 public void setScopeable(boolean scopeable);
962
963 /**
964 * Gets the user principal strategy of the portlet.
965 *
966 * @return the user principal strategy of the portlet
967 */
968 public java.lang.String getUserPrincipalStrategy();
969
970 /**
971 * Sets the user principal strategy of the portlet.
972 *
973 * @param userPrincipalStrategy the user principal strategy of the portlet
974 */
975 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy);
976
977 /**
978 * Returns true if the portlet does not share request attributes with the
979 * portal or portlets from another WAR.
980 *
981 * @return true if the portlet does not share request attributes with the
982 portal or portlets from another WAR
983 */
984 public boolean getPrivateRequestAttributes();
985
986 /**
987 * Returns true if the portlet does not share request attributes with the
988 * portal or portlets from another WAR.
989 *
990 * @return true if the portlet does not share request attributes with the
991 portal or portlets from another WAR
992 */
993 public boolean isPrivateRequestAttributes();
994
995 /**
996 * Set to true if the portlet does not share request attributes with the
997 * portal or portlets from another WAR.
998 *
999 * @param privateRequestAttributes boolean value for whether the portlet
1000 shares request attributes with the portal or portlets from another
1001 WAR
1002 */
1003 public void setPrivateRequestAttributes(boolean privateRequestAttributes);
1004
1005 /**
1006 * Returns true if the portlet does not share session attributes with the
1007 * portal.
1008 *
1009 * @return true if the portlet does not share session attributes with the
1010 portal
1011 */
1012 public boolean getPrivateSessionAttributes();
1013
1014 /**
1015 * Returns true if the portlet does not share session attributes with the
1016 * portal.
1017 *
1018 * @return true if the portlet does not share session attributes with the
1019 portal
1020 */
1021 public boolean isPrivateSessionAttributes();
1022
1023 /**
1024 * Set to true if the portlet does not share session attributes with the
1025 * portal.
1026 *
1027 * @param privateSessionAttributes boolean value for whether the portlet
1028 shares session attributes with the portal
1029 */
1030 public void setPrivateSessionAttributes(boolean privateSessionAttributes);
1031
1032 /**
1033 * Returns the render weight of the portlet.
1034 *
1035 * @return the render weight of the portlet
1036 */
1037 public int getRenderWeight();
1038
1039 /**
1040 * Sets the render weight of the portlet.
1041 *
1042 * @param renderWeight int value for the render weight of the portlet
1043 */
1044 public void setRenderWeight(int renderWeight);
1045
1046 /**
1047 * Returns true if the portlet can be displayed via Ajax.
1048 *
1049 * @return true if the portlet can be displayed via Ajax
1050 */
1051 public boolean getAjaxable();
1052
1053 /**
1054 * Returns true if the portlet can be displayed via Ajax.
1055 *
1056 * @return true if the portlet can be displayed via Ajax
1057 */
1058 public boolean isAjaxable();
1059
1060 /**
1061 * Set to true if the portlet can be displayed via Ajax.
1062 *
1063 * @param ajaxable boolean value for whether the portlet can be displayed
1064 via Ajax
1065 */
1066 public void setAjaxable(boolean ajaxable);
1067
1068 /**
1069 * Gets a list of CSS files that will be referenced from the page's header
1070 * relative to the portal's context path.
1071 *
1072 * @return a list of CSS files that will be referenced from the page's
1073 header relative to the portal's context path
1074 */
1075 public java.util.List<java.lang.String> getHeaderPortalCss();
1076
1077 /**
1078 * Sets a list of CSS files that will be referenced from the page's header
1079 * relative to the portal's context path.
1080 *
1081 * @param headerPortalCss a list of CSS files that will be referenced from
1082 the page's header relative to the portal's context path
1083 */
1084 public void setHeaderPortalCss(
1085 java.util.List<java.lang.String> headerPortalCss);
1086
1087 /**
1088 * Gets a list of CSS files that will be referenced from the page's header
1089 * relative to the portlet's context path.
1090 *
1091 * @return a list of CSS files that will be referenced from the page's
1092 header relative to the portlet's context path
1093 */
1094 public java.util.List<java.lang.String> getHeaderPortletCss();
1095
1096 /**
1097 * Sets a list of CSS files that will be referenced from the page's header
1098 * relative to the portlet's context path.
1099 *
1100 * @param headerPortletCss a list of CSS files that will be referenced from
1101 the page's header relative to the portlet's context path
1102 */
1103 public void setHeaderPortletCss(
1104 java.util.List<java.lang.String> headerPortletCss);
1105
1106 /**
1107 * Gets a list of JavaScript files that will be referenced from the page's
1108 * header relative to the portal's context path.
1109 *
1110 * @return a list of JavaScript files that will be referenced from the
1111 page's header relative to the portal's context path
1112 */
1113 public java.util.List<java.lang.String> getHeaderPortalJavaScript();
1114
1115 /**
1116 * Sets a list of JavaScript files that will be referenced from the page's
1117 * header relative to the portal's context path.
1118 *
1119 * @param headerPortalJavaScript a list of JavaScript files that will be
1120 referenced from the page's header relative to the portal's context
1121 path
1122 */
1123 public void setHeaderPortalJavaScript(
1124 java.util.List<java.lang.String> headerPortalJavaScript);
1125
1126 /**
1127 * Gets a list of JavaScript files that will be referenced from the page's
1128 * header relative to the portlet's context path.
1129 *
1130 * @return a list of JavaScript files that will be referenced from the
1131 page's header relative to the portlet's context path
1132 */
1133 public java.util.List<java.lang.String> getHeaderPortletJavaScript();
1134
1135 /**
1136 * Sets a list of JavaScript files that will be referenced from the page's
1137 * header relative to the portlet's context path.
1138 *
1139 * @param headerPortletJavaScript a list of JavaScript files that will be
1140 referenced from the page's header relative to the portlet's
1141 context path
1142 */
1143 public void setHeaderPortletJavaScript(
1144 java.util.List<java.lang.String> headerPortletJavaScript);
1145
1146 /**
1147 * Gets a list of CSS files that will be referenced from the page's footer
1148 * relative to the portal's context path.
1149 *
1150 * @return a list of CSS files that will be referenced from the page's
1151 footer relative to the portal's context path
1152 */
1153 public java.util.List<java.lang.String> getFooterPortalCss();
1154
1155 /**
1156 * Sets a list of CSS files that will be referenced from the page's footer
1157 * relative to the portal's context path.
1158 *
1159 * @param footerPortalCss a list of CSS files that will be referenced from
1160 the page's footer relative to the portal's context path
1161 */
1162 public void setFooterPortalCss(
1163 java.util.List<java.lang.String> footerPortalCss);
1164
1165 /**
1166 * Gets a list of CSS files that will be referenced from the page's footer
1167 * relative to the portlet's context path.
1168 *
1169 * @return a list of CSS files that will be referenced from the page's
1170 footer relative to the portlet's context path
1171 */
1172 public java.util.List<java.lang.String> getFooterPortletCss();
1173
1174 /**
1175 * Sets a list of CSS files that will be referenced from the page's footer
1176 * relative to the portlet's context path.
1177 *
1178 * @param footerPortletCss a list of CSS files that will be referenced from
1179 the page's footer relative to the portlet's context path
1180 */
1181 public void setFooterPortletCss(
1182 java.util.List<java.lang.String> footerPortletCss);
1183
1184 /**
1185 * Gets a list of JavaScript files that will be referenced from the page's
1186 * footer relative to the portal's context path.
1187 *
1188 * @return a list of JavaScript files that will be referenced from the
1189 page's footer relative to the portal's context path
1190 */
1191 public java.util.List<java.lang.String> getFooterPortalJavaScript();
1192
1193 /**
1194 * Sets a list of JavaScript files that will be referenced from the page's
1195 * footer relative to the portal's context path.
1196 *
1197 * @param footerPortalJavaScript a list of JavaScript files that will be
1198 referenced from the page's footer relative to the portal's context
1199 path
1200 */
1201 public void setFooterPortalJavaScript(
1202 java.util.List<java.lang.String> footerPortalJavaScript);
1203
1204 /**
1205 * Gets a list of JavaScript files that will be referenced from the page's
1206 * footer relative to the portlet's context path.
1207 *
1208 * @return a list of JavaScript files that will be referenced from the
1209 page's footer relative to the portlet's context path
1210 */
1211 public java.util.List<java.lang.String> getFooterPortletJavaScript();
1212
1213 /**
1214 * Sets a list of JavaScript files that will be referenced from the page's
1215 * footer relative to the portlet's context path.
1216 *
1217 * @param footerPortletJavaScript a list of JavaScript files that will be
1218 referenced from the page's footer relative to the portlet's
1219 context path
1220 */
1221 public void setFooterPortletJavaScript(
1222 java.util.List<java.lang.String> footerPortletJavaScript);
1223
1224 /**
1225 * Gets the name of the CSS class that will be injected in the DIV that
1226 * wraps this portlet.
1227 *
1228 * @return the name of the CSS class that will be injected in the DIV that
1229 wraps this portlet
1230 */
1231 public java.lang.String getCssClassWrapper();
1232
1233 /**
1234 * Sets the name of the CSS class that will be injected in the DIV that
1235 * wraps this portlet.
1236 *
1237 * @param cssClassWrapper the name of the CSS class that will be injected in
1238 the DIV that wraps this portlet
1239 */
1240 public void setCssClassWrapper(java.lang.String cssClassWrapper);
1241
1242 /**
1243 * Gets the Facebook integration method of the portlet.
1244 *
1245 * @return the Facebook integration method of the portlet
1246 */
1247 public java.lang.String getFacebookIntegration();
1248
1249 /**
1250 * Sets the Facebook integration method of the portlet.
1251 *
1252 * @param facebookIntegration the Facebook integration method of the portlet
1253 */
1254 public void setFacebookIntegration(java.lang.String facebookIntegration);
1255
1256 /**
1257 * Returns true if default resources for the portlet are added to a page.
1258 *
1259 * @return true if default resources for the portlet are added to a page
1260 */
1261 public boolean getAddDefaultResource();
1262
1263 /**
1264 * Returns true if default resources for the portlet are added to a page.
1265 *
1266 * @return true if default resources for the portlet are added to a page
1267 */
1268 public boolean isAddDefaultResource();
1269
1270 /**
1271 * Set to true if default resources for the portlet are added to a page.
1272 *
1273 * @param addDefaultResource boolean value for whether or not default
1274 resources for the portlet are added to a page
1275 */
1276 public void setAddDefaultResource(boolean addDefaultResource);
1277
1278 /**
1279 * Sets a string of ordered comma delimited portlet ids.
1280 *
1281 * @param roles a string of ordered comma delimited portlet ids
1282 */
1283 public void setRoles(java.lang.String roles);
1284
1285 /**
1286 * Gets an array of required roles of the portlet.
1287 *
1288 * @return an array of required roles of the portlet
1289 */
1290 public java.lang.String[] getRolesArray();
1291
1292 /**
1293 * Sets an array of required roles of the portlet.
1294 *
1295 * @param rolesArray an array of required roles of the portlet
1296 */
1297 public void setRolesArray(java.lang.String[] rolesArray);
1298
1299 /**
1300 * Gets the unlinked roles of the portlet.
1301 *
1302 * @return unlinked roles of the portlet
1303 */
1304 public java.util.Set<java.lang.String> getUnlinkedRoles();
1305
1306 /**
1307 * Sets the unlinked roles of the portlet.
1308 *
1309 * @param unlinkedRoles the unlinked roles of the portlet
1310 */
1311 public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles);
1312
1313 /**
1314 * Gets the role mappers of the portlet.
1315 *
1316 * @return role mappers of the portlet
1317 */
1318 public java.util.Map<java.lang.String, java.lang.String> getRoleMappers();
1319
1320 /**
1321 * Sets the role mappers of the portlet.
1322 *
1323 * @param roleMappers the role mappers of the portlet
1324 */
1325 public void setRoleMappers(
1326 java.util.Map<java.lang.String, java.lang.String> roleMappers);
1327
1328 /**
1329 * Link the role names set in portlet.xml with the Liferay roles set in
1330 * liferay-portlet.xml.
1331 */
1332 public void linkRoles();
1333
1334 /**
1335 * Returns true if the portlet has a role with the specified name.
1336 *
1337 * @return true if the portlet has a role with the specified name
1338 */
1339 public boolean hasRoleWithName(java.lang.String roleName);
1340
1341 /**
1342 * Returns true if the user has the permission to add the portlet to a
1343 * layout.
1344 *
1345 * @return true if the user has the permission to add the portlet to a
1346 layout
1347 */
1348 public boolean hasAddPortletPermission(long userId);
1349
1350 /**
1351 * Returns true if the portlet is a system portlet that a user cannot
1352 * manually add to their page.
1353 *
1354 * @return true if the portlet is a system portlet that a user cannot
1355 manually add to their page
1356 */
1357 public boolean getSystem();
1358
1359 /**
1360 * Returns true if the portlet is a system portlet that a user cannot
1361 * manually add to their page.
1362 *
1363 * @return true if the portlet is a system portlet that a user cannot
1364 manually add to their page
1365 */
1366 public boolean isSystem();
1367
1368 /**
1369 * Set to true if the portlet is a system portlet that a user cannot
1370 * manually add to their page.
1371 *
1372 * @param system boolean value for whether the portlet is a system portlet
1373 that a user cannot manually add to their page
1374 */
1375 public void setSystem(boolean system);
1376
1377 /**
1378 * Returns true to include the portlet and make it available to be made
1379 * active.
1380 *
1381 * @return true to include the portlet and make it available to be made
1382 active
1383 */
1384 public boolean getInclude();
1385
1386 /**
1387 * Returns true to include the portlet and make it available to be made
1388 * active.
1389 *
1390 * @return true to include the portlet and make it available to be made
1391 active
1392 */
1393 public boolean isInclude();
1394
1395 /**
1396 * Set to true to include the portlet and make it available to be made
1397 * active.
1398 *
1399 * @param include boolean value for whether to include the portlet and make
1400 it available to be made active
1401 */
1402 public void setInclude(boolean include);
1403
1404 /**
1405 * Returns <code>true</code> if the portlet is ready to be used.
1406 *
1407 * @return <code>true</code> if the portlet is ready to be used
1408 */
1409 public boolean getReady();
1410
1411 /**
1412 * Returns <code>true</code> if the portlet is ready to be used.
1413 *
1414 * @return <code>true</code> if the portlet is ready to be used
1415 */
1416 public boolean isReady();
1417
1418 /**
1419 * Set to <code>true</code> if the portlet is ready to be used.
1420 *
1421 * @param system boolean value for whether the portlet is ready to be used
1422 */
1423 public void setReady(boolean ready);
1424
1425 /**
1426 * Gets the init parameters of the portlet.
1427 *
1428 * @return init parameters of the portlet
1429 */
1430 public java.util.Map<java.lang.String, java.lang.String> getInitParams();
1431
1432 /**
1433 * Sets the init parameters of the portlet.
1434 *
1435 * @param initParams the init parameters of the portlet
1436 */
1437 public void setInitParams(
1438 java.util.Map<java.lang.String, java.lang.String> initParams);
1439
1440 /**
1441 * Gets expiration cache of the portlet.
1442 *
1443 * @return expiration cache of the portlet
1444 */
1445 public java.lang.Integer getExpCache();
1446
1447 /**
1448 * Sets expiration cache of the portlet.
1449 *
1450 * @param expCache expiration cache of the portlet
1451 */
1452 public void setExpCache(java.lang.Integer expCache);
1453
1454 /**
1455 * Gets the portlet modes of the portlet.
1456 *
1457 * @return portlet modes of the portlet
1458 */
1459 public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getPortletModes();
1460
1461 /**
1462 * Sets the portlet modes of the portlet.
1463 *
1464 * @param portletModes the portlet modes of the portlet
1465 */
1466 public void setPortletModes(
1467 java.util.Map<java.lang.String, java.util.Set<java.lang.String>> portletModes);
1468
1469 /**
1470 * Returns true if the portlet supports the specified mime type and portlet
1471 * mode.
1472 *
1473 * @return true if the portlet supports the specified mime type and portlet
1474 mode
1475 */
1476 public boolean hasPortletMode(java.lang.String mimeType,
1477 javax.portlet.PortletMode portletMode);
1478
1479 /**
1480 * Gets a list of all portlet modes supported by the portlet.
1481 *
1482 * @return a list of all portlet modes supported by the portlet
1483 */
1484 public java.util.Set<java.lang.String> getAllPortletModes();
1485
1486 /**
1487 * Returns true if the portlet supports more than one mime type.
1488 *
1489 * @return true if the portlet supports more than one mime type
1490 */
1491 public boolean hasMultipleMimeTypes();
1492
1493 /**
1494 * Gets the window states of the portlet.
1495 *
1496 * @return window states of the portlet
1497 */
1498 public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getWindowStates();
1499
1500 /**
1501 * Sets the window states of the portlet.
1502 *
1503 * @param windowStates the window states of the portlet
1504 */
1505 public void setWindowStates(
1506 java.util.Map<java.lang.String, java.util.Set<java.lang.String>> windowStates);
1507
1508 /**
1509 * Returns true if the portlet supports the specified mime type and window
1510 * state.
1511 *
1512 * @return true if the portlet supports the specified mime type and window
1513 state
1514 */
1515 public boolean hasWindowState(java.lang.String mimeType,
1516 javax.portlet.WindowState windowState);
1517
1518 /**
1519 * Gets a list of all window states supported by the portlet.
1520 *
1521 * @return a list of all window states supported by the portlet
1522 */
1523 public java.util.Set<java.lang.String> getAllWindowStates();
1524
1525 /**
1526 * Gets the supported locales of the portlet.
1527 *
1528 * @return supported locales of the portlet
1529 */
1530 public java.util.Set<java.lang.String> getSupportedLocales();
1531
1532 /**
1533 * Sets the supported locales of the portlet.
1534 *
1535 * @param supportedLocales the supported locales of the portlet
1536 */
1537 public void setSupportedLocales(
1538 java.util.Set<java.lang.String> supportedLocales);
1539
1540 /**
1541 * Gets the resource bundle of the portlet.
1542 *
1543 * @return resource bundle of the portlet
1544 */
1545 public java.lang.String getResourceBundle();
1546
1547 /**
1548 * Sets the resource bundle of the portlet.
1549 *
1550 * @param resourceBundle the resource bundle of the portlet
1551 */
1552 public void setResourceBundle(java.lang.String resourceBundle);
1553
1554 /**
1555 * Gets the portlet info of the portlet.
1556 *
1557 * @return portlet info of the portlet
1558 */
1559 public com.liferay.portal.model.PortletInfo getPortletInfo();
1560
1561 /**
1562 * Sets the portlet info of the portlet.
1563 *
1564 * @param portletInfo the portlet info of the portlet
1565 */
1566 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo);
1567
1568 /**
1569 * Gets the filters of the portlet.
1570 *
1571 * @return filters of the portlet
1572 */
1573 public java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> getPortletFilters();
1574
1575 /**
1576 * Sets the filters of the portlet.
1577 *
1578 * @param portletFilters the filters of the portlet
1579 */
1580 public void setPortletFilters(
1581 java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> portletFilters);
1582
1583 /**
1584 * Adds a supported processing event.
1585 */
1586 public void addProcessingEvent(
1587 com.liferay.portal.kernel.xml.QName processingEvent);
1588
1589 /**
1590 * Gets the supported processing event from a namespace URI and a local
1591 * part.
1592 *
1593 * @return the supported processing event from a namespace URI and a local
1594 part
1595 */
1596 public com.liferay.portal.kernel.xml.QName getProcessingEvent(
1597 java.lang.String uri, java.lang.String localPart);
1598
1599 /**
1600 * Gets the supported processing events of the portlet.
1601 *
1602 * @return supported processing events of the portlet
1603 */
1604 public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents();
1605
1606 /**
1607 * Sets the supported processing events of the portlet.
1608 *
1609 * @param processingEvents the supported processing events of the portlet
1610 */
1611 public void setProcessingEvents(
1612 java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents);
1613
1614 /**
1615 * Adds a supported publishing event.
1616 */
1617 public void addPublishingEvent(
1618 com.liferay.portal.kernel.xml.QName publishingEvent);
1619
1620 /**
1621 * Gets the supported publishing events of the portlet.
1622 *
1623 * @return supported publishing events of the portlet
1624 */
1625 public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents();
1626
1627 /**
1628 * Sets the supported publishing events of the portlet.
1629 *
1630 * @param publishingEvents the supported publishing events of the portlet
1631 */
1632 public void setPublishingEvents(
1633 java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents);
1634
1635 /**
1636 * Adds a supported public render parameter.
1637 *
1638 * @param publicRenderParameter a supported public render parameter
1639 */
1640 public void addPublicRenderParameter(
1641 com.liferay.portal.model.PublicRenderParameter publicRenderParameter);
1642
1643 /**
1644 * Gets the supported public render parameter from an identifier.
1645 *
1646 * @return the supported public render parameter from an identifier
1647 */
1648 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
1649 java.lang.String identifier);
1650
1651 /**
1652 * Gets the supported public render parameter from a namespace URI and a
1653 * local part.
1654 *
1655 * @return the supported public render parameter from a namespace URI and a
1656 local part
1657 */
1658 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter(
1659 java.lang.String uri, java.lang.String localPart);
1660
1661 /**
1662 * Gets the supported public render parameters of the portlet.
1663 *
1664 * @return the supported public render parameters of the portlet
1665 */
1666 public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters();
1667
1668 /**
1669 * Sets the supported public render parameters of the portlet.
1670 *
1671 * @param publicRenderParameters the supported public render parameters of
1672 the portlet
1673 */
1674 public void setPublicRenderParameters(
1675 java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters);
1676
1677 /**
1678 * Gets the servlet context path of the portlet.
1679 *
1680 * @return the servlet context path of the portlet
1681 */
1682 public java.lang.String getContextPath();
1683
1684 /**
1685 * Get the application this portlet belongs to.
1686 *
1687 * @return the application this portlet belongs to
1688 */
1689 public com.liferay.portal.model.PortletApp getPortletApp();
1690
1691 /**
1692 * Sets the application this portlet belongs to.
1693 *
1694 * @param portletApp the application this portlet belongs to
1695 */
1696 public void setPortletApp(com.liferay.portal.model.PortletApp portletApp);
1697
1698 /**
1699 * Returns true if the portlet is found in a WAR file.
1700 *
1701 * @param portletId the cloned instance portlet id
1702 * @return a cloned instance of the portlet
1703 */
1704 public com.liferay.portal.model.Portlet getClonedInstance(
1705 java.lang.String portletId);
1706
1707 /**
1708 * Returns true if the portlet is a static portlet that is cannot be moved.
1709 *
1710 * @return true if the portlet is a static portlet that is cannot be moved
1711 */
1712 public boolean getStatic();
1713
1714 /**
1715 * Returns true if the portlet is a static portlet that is cannot be moved.
1716 *
1717 * @return true if the portlet is a static portlet that is cannot be moved
1718 */
1719 public boolean isStatic();
1720
1721 /**
1722 * Set to true if the portlet is a static portlet that is cannot be moved.
1723 *
1724 * @param staticPortlet boolean value for whether the portlet is a static
1725 portlet that cannot be moved
1726 */
1727 public void setStatic(boolean staticPortlet);
1728
1729 /**
1730 * Returns true if the portlet is a static portlet at the start of a list of
1731 * portlets.
1732 *
1733 * @return true if the portlet is a static portlet at the start of a list of
1734 portlets
1735 */
1736 public boolean getStaticStart();
1737
1738 /**
1739 * Returns true if the portlet is a static portlet at the start of a list of
1740 * portlets.
1741 *
1742 * @return true if the portlet is a static portlet at the start of a list of
1743 portlets
1744 */
1745 public boolean isStaticStart();
1746
1747 /**
1748 * Set to true if the portlet is a static portlet at the start of a list of
1749 * portlets.
1750 *
1751 * @param staticPortletStart boolean value for whether the portlet is a
1752 static portlet at the start of a list of portlets
1753 */
1754 public void setStaticStart(boolean staticPortletStart);
1755
1756 /**
1757 * Returns true if the portlet is a static portlet at the end of a list of
1758 * portlets.
1759 *
1760 * @return true if the portlet is a static portlet at the end of a list of
1761 portlets
1762 */
1763 public boolean getStaticEnd();
1764
1765 /**
1766 * Returns true if the portlet is a static portlet at the end of a list of
1767 * portlets.
1768 *
1769 * @return true if the portlet is a static portlet at the end of a list of
1770 portlets
1771 */
1772 public boolean isStaticEnd();
1773
1774 /**
1775 * Returns true if the portlet is an undeployed portlet.
1776 *
1777 * @return true if the portlet is a placeholder of an undeployed portlet
1778 */
1779 public boolean getUndeployedPortlet();
1780
1781 /**
1782 * Returns true if the portlet is an undeployed portlet.
1783 *
1784 * @return true if the portlet is a placeholder of an undeployed portlet
1785 */
1786 public boolean isUndeployedPortlet();
1787
1788 /**
1789 * Set to true if the portlet is an undeployed portlet.
1790 *
1791 * @param undeployedPortlet boolean value for whether the portlet is an
1792 undeployed portlet
1793 */
1794 public void setUndeployedPortlet(boolean undeployedPortlet);
1795
1796 /**
1797 * Creates and returns a copy of this object.
1798 *
1799 * @return a copy of this object
1800 */
1801 public java.lang.Object clone();
1802
1803 /**
1804 * Compares this portlet to the specified object.
1805 *
1806 * @param portlet the portlet to compare this portlet against
1807 * @return the value 0 if the argument portlet is equal to this portlet; a
1808 value less than -1 if this portlet is less than the portlet
1809 argument; and 1 if this portlet is greater than the portlet
1810 argument
1811 */
1812 public int compareTo(com.liferay.portal.model.Portlet portlet);
1813
1814 /**
1815 * Checks whether this portlet is equal to the specified object.
1816 *
1817 * @param obj the object to compare this portlet against
1818 * @return true if the portlet is equal to the specified object
1819 */
1820 public boolean equals(java.lang.Object obj);
1821}