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