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