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