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