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 name of the portlet display style class of the portlet. 611 * 612 * @return the name of the portlet display style class of the portlet 613 */ 614 public java.lang.String getPortletDisplayTemplateHandlerClass(); 615 616 /** 617 * Returns the portlet display style instance of the portlet. 618 * 619 * @return the portlet display style instance of the portlet 620 */ 621 public com.liferay.portal.kernel.portletdisplaytemplate.PortletDisplayTemplateHandler getPortletDisplayTemplateHandlerInstance(); 622 623 /** 624 * Returns the filters of the portlet. 625 * 626 * @return filters of the portlet 627 */ 628 public java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> getPortletFilters(); 629 630 /** 631 * Returns the portlet info of the portlet. 632 * 633 * @return portlet info of the portlet 634 */ 635 public com.liferay.portal.model.PortletInfo getPortletInfo(); 636 637 /** 638 * Returns the name of the portlet layout listener class of the portlet. 639 * 640 * @return the name of the portlet layout listener class of the portlet 641 */ 642 public java.lang.String getPortletLayoutListenerClass(); 643 644 /** 645 * Returns the portlet layout listener instance of the portlet. 646 * 647 * @return the portlet layout listener instance of the portlet 648 */ 649 public com.liferay.portal.kernel.portlet.PortletLayoutListener getPortletLayoutListenerInstance(); 650 651 /** 652 * Returns the portlet modes of the portlet. 653 * 654 * @return portlet modes of the portlet 655 */ 656 public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getPortletModes(); 657 658 /** 659 * Returns the name of the portlet. 660 * 661 * @return the display name of the portlet 662 */ 663 public java.lang.String getPortletName(); 664 665 /** 666 * Returns the name of the portlet URL class of the portlet. 667 * 668 * @return the name of the portlet URL class of the portlet 669 */ 670 public java.lang.String getPortletURLClass(); 671 672 /** 673 * Returns <code>true</code> if preferences are shared across the entire 674 * company. 675 * 676 * @return <code>true</code> if preferences are shared across the entire 677 company 678 */ 679 public boolean getPreferencesCompanyWide(); 680 681 /** 682 * Returns <code>true</code> if preferences are owned by the group when the 683 * portlet is shown in a group layout. Returns <code>false</code> if 684 * preferences are owned by the user at all times. 685 * 686 * @return <code>true</code> if preferences are owned by the group when the 687 portlet is shown in a group layout; <code>false</code> if 688 preferences are owned by the user at all times. 689 */ 690 public boolean getPreferencesOwnedByGroup(); 691 692 /** 693 * Returns <code>true</code> if preferences are unique per layout. 694 * 695 * @return <code>true</code> if preferences are unique per layout 696 */ 697 public boolean getPreferencesUniquePerLayout(); 698 699 /** 700 * Returns the name of the preferences validator class of the portlet. 701 * 702 * @return the name of the preferences validator class of the portlet 703 */ 704 public java.lang.String getPreferencesValidator(); 705 706 /** 707 * Returns <code>true</code> if the portlet does not share request 708 * attributes with the portal or portlets from another WAR. 709 * 710 * @return <code>true</code> if the portlet does not share request 711 attributes with the portal or portlets from another WAR 712 */ 713 public boolean getPrivateRequestAttributes(); 714 715 /** 716 * Returns <code>true</code> if the portlet does not share session 717 * attributes with the portal. 718 * 719 * @return <code>true</code> if the portlet does not share session 720 attributes with the portal 721 */ 722 public boolean getPrivateSessionAttributes(); 723 724 /** 725 * Returns the supported processing event from a namespace URI and a local 726 * part. 727 * 728 * @param uri the namespace URI 729 * @param localPart the local part 730 * @return the supported processing event from a namespace URI and a local 731 part 732 */ 733 public com.liferay.portal.kernel.xml.QName getProcessingEvent( 734 java.lang.String uri, java.lang.String localPart); 735 736 /** 737 * Returns the supported processing events of the portlet. 738 * 739 * @return supported processing events of the portlet 740 */ 741 public java.util.Set<com.liferay.portal.kernel.xml.QName> getProcessingEvents(); 742 743 /** 744 * Returns the supported public render parameter from an identifier. 745 * 746 * @param identifier the identifier 747 * @return the supported public render parameter from an identifier 748 */ 749 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter( 750 java.lang.String identifier); 751 752 /** 753 * Returns the supported public render parameter from a namespace URI and a 754 * local part. 755 * 756 * @param uri the namespace URI 757 * @param localPart the local part 758 * @return the supported public render parameter from a namespace URI and a 759 local part 760 */ 761 public com.liferay.portal.model.PublicRenderParameter getPublicRenderParameter( 762 java.lang.String uri, java.lang.String localPart); 763 764 /** 765 * Returns the supported public render parameters of the portlet. 766 * 767 * @return the supported public render parameters of the portlet 768 */ 769 public java.util.Set<com.liferay.portal.model.PublicRenderParameter> getPublicRenderParameters(); 770 771 /** 772 * Returns the supported publishing events of the portlet. 773 * 774 * @return supported publishing events of the portlet 775 */ 776 public java.util.Set<com.liferay.portal.kernel.xml.QName> getPublishingEvents(); 777 778 /** 779 * Returns <code>true</code> if the portlet is ready to be used. 780 * 781 * @return <code>true</code> if the portlet is ready to be used 782 */ 783 public boolean getReady(); 784 785 /** 786 * Returns <code>true</code> if the portlet supports remoting. 787 * 788 * @return <code>true</code> if the portlet supports remoting 789 */ 790 public boolean getRemoteable(); 791 792 /** 793 * Returns the render timeout of the portlet. 794 * 795 * @return the render timeout of the portlet 796 */ 797 public int getRenderTimeout(); 798 799 /** 800 * Returns the render weight of the portlet. 801 * 802 * @return the render weight of the portlet 803 */ 804 public int getRenderWeight(); 805 806 /** 807 * Returns the resource bundle of the portlet. 808 * 809 * @return resource bundle of the portlet 810 */ 811 public java.lang.String getResourceBundle(); 812 813 /** 814 * Returns <code>true</code> if the portlet restores to the current view 815 * from the maximized state. 816 * 817 * @return <code>true</code> if the portlet restores to the current view 818 from the maximized state 819 */ 820 public boolean getRestoreCurrentView(); 821 822 /** 823 * Returns the role mappers of the portlet. 824 * 825 * @return role mappers of the portlet 826 */ 827 public java.util.Map<java.lang.String, java.lang.String> getRoleMappers(); 828 829 /** 830 * Returns an array of required roles of the portlet. 831 * 832 * @return an array of required roles of the portlet 833 */ 834 public java.lang.String[] getRolesArray(); 835 836 /** 837 * Returns the root portlet of this portlet instance. 838 * 839 * @return the root portlet of this portlet instance 840 */ 841 public com.liferay.portal.model.Portlet getRootPortlet(); 842 843 /** 844 * Returns the root portlet ID of the portlet. 845 * 846 * @return the root portlet ID of the portlet 847 */ 848 public java.lang.String getRootPortletId(); 849 850 /** 851 * Returns the scheduler entries of the portlet. 852 * 853 * @return the scheduler entries of the portlet 854 */ 855 public java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> getSchedulerEntries(); 856 857 /** 858 * Returns <code>true</code> if the portlet supports scoping of data. 859 * 860 * @return <code>true</code> if the portlet supports scoping of data 861 */ 862 public boolean getScopeable(); 863 864 /** 865 * Returns <code>true</code> if users are shown that they do not have access 866 * to the portlet. 867 * 868 * @return <code>true</code> if users are shown that they do not have access 869 to the portlet 870 */ 871 public boolean getShowPortletAccessDenied(); 872 873 /** 874 * Returns <code>true</code> if users are shown that the portlet is 875 * inactive. 876 * 877 * @return <code>true</code> if users are shown that the portlet is inactive 878 */ 879 public boolean getShowPortletInactive(); 880 881 /** 882 * Returns the name of the social activity interpreter class of the portlet. 883 * 884 * @return the name of the social activity interpreter class of the portlet 885 */ 886 public java.lang.String getSocialActivityInterpreterClass(); 887 888 /** 889 * Returns the name of the social activity interpreter instance of the 890 * portlet. 891 * 892 * @return the name of the social activity interpreter instance of the 893 portlet 894 */ 895 public com.liferay.portlet.social.model.SocialActivityInterpreter getSocialActivityInterpreterInstance(); 896 897 /** 898 * Returns the name of the social request interpreter class of the portlet. 899 * 900 * @return the name of the social request interpreter class of the portlet 901 */ 902 public java.lang.String getSocialRequestInterpreterClass(); 903 904 /** 905 * Returns the name of the social request interpreter instance of the 906 * portlet. 907 * 908 * @return the name of the social request interpreter instance of the 909 portlet 910 */ 911 public com.liferay.portlet.social.model.SocialRequestInterpreter getSocialRequestInterpreterInstance(); 912 913 /** 914 * Returns <code>true</code> if the portlet is a static portlet that is 915 * cannot be moved. 916 * 917 * @return <code>true</code> if the portlet is a static portlet that is 918 cannot be moved 919 */ 920 public boolean getStatic(); 921 922 /** 923 * Returns <code>true</code> if the portlet is a static portlet at the end 924 * of a list of portlets. 925 * 926 * @return <code>true</code> if the portlet is a static portlet at the end 927 of a list of portlets 928 */ 929 public boolean getStaticEnd(); 930 931 /** 932 * Returns the path for static resources served by this portlet. 933 * 934 * @return the path for static resources served by this portlet 935 */ 936 public java.lang.String getStaticResourcePath(); 937 938 /** 939 * Returns <code>true</code> if the portlet is a static portlet at the start 940 * of a list of portlets. 941 * 942 * @return <code>true</code> if the portlet is a static portlet at the start 943 of a list of portlets 944 */ 945 public boolean getStaticStart(); 946 947 /** 948 * Returns the struts path of the portlet. 949 * 950 * @return the struts path of the portlet 951 */ 952 public java.lang.String getStrutsPath(); 953 954 /** 955 * Returns the supported locales of the portlet. 956 * 957 * @return supported locales of the portlet 958 */ 959 public java.util.Set<java.lang.String> getSupportedLocales(); 960 961 /** 962 * Returns <code>true</code> if the portlet is a system portlet that a user 963 * cannot manually add to their page. 964 * 965 * @return <code>true</code> if the portlet is a system portlet that a user 966 cannot manually add to their page 967 */ 968 public boolean getSystem(); 969 970 /** 971 * Returns the timestamp of the portlet. 972 * 973 * @return the timestamp of the portlet 974 */ 975 public long getTimestamp(); 976 977 /** 978 * Returns the names of the classes that represent trash handlers associated 979 * with the portlet. 980 * 981 * @return the names of the classes that represent trash handlers associated 982 with the portlet 983 */ 984 public java.util.List<java.lang.String> getTrashHandlerClasses(); 985 986 /** 987 * Returns the trash handler instances of the portlet. 988 * 989 * @return the trash handler instances of the portlet 990 */ 991 public java.util.List<com.liferay.portal.kernel.trash.TrashHandler> getTrashHandlerInstances(); 992 993 /** 994 * Returns <code>true</code> if the portlet is an undeployed portlet. 995 * 996 * @return <code>true</code> if the portlet is a placeholder of an 997 undeployed portlet 998 */ 999 public boolean getUndeployedPortlet(); 1000 1001 /** 1002 * Returns the unlinked roles of the portlet. 1003 * 1004 * @return unlinked roles of the portlet 1005 */ 1006 public java.util.Set<java.lang.String> getUnlinkedRoles(); 1007 1008 /** 1009 * Returns the name of the URL encoder class of the portlet. 1010 * 1011 * @return the name of the URL encoder class of the portlet 1012 */ 1013 public java.lang.String getURLEncoderClass(); 1014 1015 /** 1016 * Returns the URL encoder instance of the portlet. 1017 * 1018 * @return the URL encoder instance of the portlet 1019 */ 1020 public com.liferay.portal.kernel.servlet.URLEncoder getURLEncoderInstance(); 1021 1022 /** 1023 * Returns <code>true</code> if the portlet uses the default template. 1024 * 1025 * @return <code>true</code> if the portlet uses the default template 1026 */ 1027 public boolean getUseDefaultTemplate(); 1028 1029 /** 1030 * Returns the user ID of the portlet. This only applies when the portlet is 1031 * added by a user in a customizable layout. 1032 * 1033 * @return the user ID of the portlet 1034 */ 1035 public long getUserId(); 1036 1037 /** 1038 * Returns the user principal strategy of the portlet. 1039 * 1040 * @return the user principal strategy of the portlet 1041 */ 1042 public java.lang.String getUserPrincipalStrategy(); 1043 1044 /** 1045 * Returns the virtual path of the portlet. 1046 * 1047 * @return the virtual path of the portlet 1048 */ 1049 public java.lang.String getVirtualPath(); 1050 1051 /** 1052 * Returns the name of the WebDAV storage class of the portlet. 1053 * 1054 * @return the name of the WebDAV storage class of the portlet 1055 */ 1056 public java.lang.String getWebDAVStorageClass(); 1057 1058 /** 1059 * Returns the name of the WebDAV storage instance of the portlet. 1060 * 1061 * @return the name of the WebDAV storage instance of the portlet 1062 */ 1063 public com.liferay.portal.kernel.webdav.WebDAVStorage getWebDAVStorageInstance(); 1064 1065 /** 1066 * Returns the name of the WebDAV storage token of the portlet. 1067 * 1068 * @return the name of the WebDAV storage token of the portlet 1069 */ 1070 public java.lang.String getWebDAVStorageToken(); 1071 1072 /** 1073 * Returns the window states of the portlet. 1074 * 1075 * @return window states of the portlet 1076 */ 1077 public java.util.Map<java.lang.String, java.util.Set<java.lang.String>> getWindowStates(); 1078 1079 /** 1080 * Returns the names of the classes that represent workflow handlers 1081 * associated with the portlet. 1082 * 1083 * @return the names of the classes that represent workflow handlers 1084 associated with the portlet 1085 */ 1086 public java.util.List<java.lang.String> getWorkflowHandlerClasses(); 1087 1088 /** 1089 * Returns the workflow handler instances of the portlet. 1090 * 1091 * @return the workflow handler instances of the portlet 1092 */ 1093 public java.util.List<com.liferay.portal.kernel.workflow.WorkflowHandler> getWorkflowHandlerInstances(); 1094 1095 /** 1096 * Returns the name of the XML-RPC method class of the portlet. 1097 * 1098 * @return the name of the XML-RPC method class of the portlet 1099 */ 1100 public java.lang.String getXmlRpcMethodClass(); 1101 1102 /** 1103 * Returns the name of the XML-RPC method instance of the portlet. 1104 * 1105 * @return the name of the XML-RPC method instance of the portlet 1106 */ 1107 public com.liferay.portal.kernel.xmlrpc.Method getXmlRpcMethodInstance(); 1108 1109 /** 1110 * Returns <code>true</code> if the user has the permission to add the 1111 * portlet to a layout. 1112 * 1113 * @param userId the primary key of the user 1114 * @return <code>true</code> if the user has the permission to add the 1115 portlet to a layout 1116 */ 1117 public boolean hasAddPortletPermission(long userId); 1118 1119 /** 1120 * Returns <code>true</code> if the portlet supports more than one mime 1121 * type. 1122 * 1123 * @return <code>true</code> if the portlet supports more than one mime type 1124 */ 1125 public boolean hasMultipleMimeTypes(); 1126 1127 /** 1128 * Returns <code>true</code> if the portlet supports the specified mime type 1129 * and portlet mode. 1130 * 1131 * @param mimeType the mime type 1132 * @param portletMode the portlet mode 1133 * @return <code>true</code> if the portlet supports the specified mime type 1134 and portlet mode 1135 */ 1136 public boolean hasPortletMode(java.lang.String mimeType, 1137 javax.portlet.PortletMode portletMode); 1138 1139 /** 1140 * Returns <code>true</code> if the portlet has a role with the specified 1141 * name. 1142 * 1143 * @param roleName the role name 1144 * @return <code>true</code> if the portlet has a role with the specified 1145 name 1146 */ 1147 public boolean hasRoleWithName(java.lang.String roleName); 1148 1149 /** 1150 * Returns <code>true</code> if the portlet supports the specified mime type 1151 * and window state. 1152 * 1153 * @param mimeType the mime type 1154 * @param windowState the window state 1155 * @return <code>true</code> if the portlet supports the specified mime type 1156 and window state 1157 */ 1158 public boolean hasWindowState(java.lang.String mimeType, 1159 javax.portlet.WindowState windowState); 1160 1161 /** 1162 * Returns <code>true</code> if an action URL for this portlet should cause 1163 * an auto redirect. 1164 * 1165 * @return <code>true</code> if an action URL for this portlet should cause 1166 an auto redirect 1167 */ 1168 public boolean isActionURLRedirect(); 1169 1170 /** 1171 * Returns <code>true</code> if default resources for the portlet are added 1172 * to a page. 1173 * 1174 * @return <code>true</code> if default resources for the portlet are added 1175 to a page 1176 */ 1177 public boolean isAddDefaultResource(); 1178 1179 /** 1180 * Returns <code>true</code> if the portlet can be displayed via Ajax. 1181 * 1182 * @return <code>true</code> if the portlet can be displayed via Ajax 1183 */ 1184 public boolean isAjaxable(); 1185 1186 /** 1187 * Returns <code>true</code> to include the portlet and make it available to 1188 * be made active. 1189 * 1190 * @return <code>true</code> to include the portlet and make it available to 1191 be made active 1192 */ 1193 public boolean isInclude(); 1194 1195 /** 1196 * Returns <code>true</code> if the portlet can be added multiple times to a 1197 * layout. 1198 * 1199 * @return <code>true</code> if the portlet can be added multiple times to a 1200 layout 1201 */ 1202 public boolean isInstanceable(); 1203 1204 /** 1205 * Returns <code>true</code> to allow the portlet to be cached within the 1206 * layout. 1207 * 1208 * @return <code>true</code> if the portlet can be cached within the layout 1209 */ 1210 public boolean isLayoutCacheable(); 1211 1212 /** 1213 * Returns <code>true</code> if the portlet goes into the maximized state 1214 * when the user goes into the edit mode. 1215 * 1216 * @return <code>true</code> if the portlet goes into the maximized state 1217 when the user goes into the edit mode 1218 */ 1219 public boolean isMaximizeEdit(); 1220 1221 /** 1222 * Returns <code>true</code> if the portlet goes into the maximized state 1223 * when the user goes into the help mode. 1224 * 1225 * @return <code>true</code> if the portlet goes into the maximized state 1226 when the user goes into the help mode 1227 */ 1228 public boolean isMaximizeHelp(); 1229 1230 /** 1231 * Returns <code>true</code> if the portlet goes into the pop up state when 1232 * the user goes into the print mode. 1233 * 1234 * @return <code>true</code> if the portlet goes into the pop up state when 1235 the user goes into the print mode 1236 */ 1237 public boolean isPopUpPrint(); 1238 1239 /** 1240 * Returns <code>true</code> if preferences are shared across the entire 1241 * company. 1242 * 1243 * @return <code>true</code> if preferences are shared across the entire 1244 company 1245 */ 1246 public boolean isPreferencesCompanyWide(); 1247 1248 /** 1249 * Returns <code>true</code> if preferences are owned by the group when the 1250 * portlet is shown in a group layout. Returns <code>false</code> if 1251 * preferences are owned by the user at all times. 1252 * 1253 * @return <code>true</code> if preferences are owned by the group when the 1254 portlet is shown in a group layout; <code>false</code> if 1255 preferences are owned by the user at all times. 1256 */ 1257 public boolean isPreferencesOwnedByGroup(); 1258 1259 /** 1260 * Returns <code>true</code> if preferences are unique per layout. 1261 * 1262 * @return <code>true</code> if preferences are unique per layout 1263 */ 1264 public boolean isPreferencesUniquePerLayout(); 1265 1266 /** 1267 * Returns <code>true</code> if the portlet does not share request 1268 * attributes with the portal or portlets from another WAR. 1269 * 1270 * @return <code>true</code> if the portlet does not share request 1271 attributes with the portal or portlets from another WAR 1272 */ 1273 public boolean isPrivateRequestAttributes(); 1274 1275 /** 1276 * Returns <code>true</code> if the portlet does not share session 1277 * attributes with the portal. 1278 * 1279 * @return <code>true</code> if the portlet does not share session 1280 attributes with the portal 1281 */ 1282 public boolean isPrivateSessionAttributes(); 1283 1284 /** 1285 * Returns <code>true</code> if the portlet is ready to be used. 1286 * 1287 * @return <code>true</code> if the portlet is ready to be used 1288 */ 1289 public boolean isReady(); 1290 1291 /** 1292 * Returns <code>true</code> if the portlet supports remoting. 1293 * 1294 * @return <code>true</code> if the portlet supports remoting 1295 */ 1296 public boolean isRemoteable(); 1297 1298 /** 1299 * Returns <code>true</code> if the portlet restores to the current view 1300 * from the maximized state. 1301 * 1302 * @return <code>true</code> if the portlet restores to the current view 1303 from the maximized state 1304 */ 1305 public boolean isRestoreCurrentView(); 1306 1307 /** 1308 * Returns <code>true</code> if the portlet supports scoping of data. 1309 * 1310 * @return <code>true</code> if the portlet supports scoping of data 1311 */ 1312 public boolean isScopeable(); 1313 1314 /** 1315 * Returns <code>true</code> if users are shown that they do not have access 1316 * to the portlet. 1317 * 1318 * @return <code>true</code> if users are shown that they do not have access 1319 to the portlet 1320 */ 1321 public boolean isShowPortletAccessDenied(); 1322 1323 /** 1324 * Returns <code>true</code> if users are shown that the portlet is 1325 * inactive. 1326 * 1327 * @return <code>true</code> if users are shown that the portlet is inactive 1328 */ 1329 public boolean isShowPortletInactive(); 1330 1331 /** 1332 * Returns <code>true</code> if the portlet is a static portlet that is 1333 * cannot be moved. 1334 * 1335 * @return <code>true</code> if the portlet is a static portlet that is 1336 cannot be moved 1337 */ 1338 public boolean isStatic(); 1339 1340 /** 1341 * Returns <code>true</code> if the portlet is a static portlet at the end 1342 * of a list of portlets. 1343 * 1344 * @return <code>true</code> if the portlet is a static portlet at the end 1345 of a list of portlets 1346 */ 1347 public boolean isStaticEnd(); 1348 1349 /** 1350 * Returns <code>true</code> if the portlet is a static portlet at the start 1351 * of a list of portlets. 1352 * 1353 * @return <code>true</code> if the portlet is a static portlet at the start 1354 of a list of portlets 1355 */ 1356 public boolean isStaticStart(); 1357 1358 /** 1359 * Returns <code>true</code> if the portlet is a system portlet that a user 1360 * cannot manually add to their page. 1361 * 1362 * @return <code>true</code> if the portlet is a system portlet that a user 1363 cannot manually add to their page 1364 */ 1365 public boolean isSystem(); 1366 1367 /** 1368 * Returns <code>true</code> if the portlet is an undeployed portlet. 1369 * 1370 * @return <code>true</code> if the portlet is a placeholder of an 1371 undeployed portlet 1372 */ 1373 public boolean isUndeployedPortlet(); 1374 1375 /** 1376 * Returns <code>true</code> if the portlet uses the default template. 1377 * 1378 * @return <code>true</code> if the portlet uses the default template 1379 */ 1380 public boolean isUseDefaultTemplate(); 1381 1382 /** 1383 * Link the role names set in portlet.xml with the Liferay roles set in 1384 * liferay-portlet.xml. 1385 */ 1386 public void linkRoles(); 1387 1388 /** 1389 * Sets the action timeout of the portlet. 1390 * 1391 * @param actionTimeout the action timeout of the portlet 1392 */ 1393 public void setActionTimeout(int actionTimeout); 1394 1395 /** 1396 * Set to <code>true</code> if an action URL for this portlet should cause 1397 * an auto redirect. 1398 * 1399 * @param actionURLRedirect boolean value for whether an action URL for this 1400 portlet should cause an auto redirect 1401 */ 1402 public void setActionURLRedirect(boolean actionURLRedirect); 1403 1404 /** 1405 * Set to <code>true</code> if default resources for the portlet are added 1406 * to a page. 1407 * 1408 * @param addDefaultResource boolean value for whether or not default 1409 resources for the portlet are added to a page 1410 */ 1411 public void setAddDefaultResource(boolean addDefaultResource); 1412 1413 /** 1414 * Set to <code>true</code> if the portlet can be displayed via Ajax. 1415 * 1416 * @param ajaxable boolean value for whether the portlet can be displayed 1417 via Ajax 1418 */ 1419 public void setAjaxable(boolean ajaxable); 1420 1421 /** 1422 * Sets the name of the classes that represent asset types associated with 1423 * the portlet. 1424 * 1425 * @param assetRendererFactoryClasses the names of the classes that 1426 represent asset types associated with the portlet 1427 */ 1428 public void setAssetRendererFactoryClasses( 1429 java.util.List<java.lang.String> assetRendererFactoryClasses); 1430 1431 /** 1432 * Sets the name of the classes that represent atom collection adapters 1433 * associated with the portlet. 1434 * 1435 * @param atomCollectionAdapterClasses the names of the classes that 1436 represent atom collection adapters associated with the portlet 1437 */ 1438 public void setAtomCollectionAdapterClasses( 1439 java.util.List<java.lang.String> atomCollectionAdapterClasses); 1440 1441 /** 1442 * Sets the names of the parameters that will be automatically propagated 1443 * through the portlet. 1444 * 1445 * @param autopropagatedParameters the names of the parameters that will be 1446 automatically propagated through the portlet 1447 */ 1448 public void setAutopropagatedParameters( 1449 java.util.Set<java.lang.String> autopropagatedParameters); 1450 1451 /** 1452 * Sets the configuration action class of the portlet. 1453 * 1454 * @param configurationActionClass the configuration action class of the 1455 portlet 1456 */ 1457 public void setConfigurationActionClass( 1458 java.lang.String configurationActionClass); 1459 1460 /** 1461 * Set the name of the category of the Control Panel where the portlet will 1462 * be shown. 1463 * 1464 * @param controlPanelEntryCategory the name of the category of the Control 1465 Panel where the portlet will be shown 1466 */ 1467 public void setControlPanelEntryCategory( 1468 java.lang.String controlPanelEntryCategory); 1469 1470 /** 1471 * Sets the name of the class that will control when the portlet will be 1472 * shown in the Control Panel. 1473 * 1474 * @param controlPanelEntryClass the name of the class that will control 1475 when the portlet will be shown in the Control Panel 1476 */ 1477 public void setControlPanelEntryClass( 1478 java.lang.String controlPanelEntryClass); 1479 1480 /** 1481 * Sets the relative weight of the portlet with respect to the other 1482 * portlets in the same category of the Control Panel. 1483 * 1484 * @param controlPanelEntryWeight the relative weight of the portlet with 1485 respect to the other portlets in the same category of the Control 1486 Panel 1487 */ 1488 public void setControlPanelEntryWeight(double controlPanelEntryWeight); 1489 1490 /** 1491 * Sets the name of the CSS class that will be injected in the DIV that 1492 * wraps this portlet. 1493 * 1494 * @param cssClassWrapper the name of the CSS class that will be injected in 1495 the DIV that wraps this portlet 1496 */ 1497 public void setCssClassWrapper(java.lang.String cssClassWrapper); 1498 1499 /** 1500 * Sets the name of the classes that represent custom attribute displays 1501 * associated with the portlet. 1502 * 1503 * @param customAttributesDisplayClasses the names of the classes that 1504 represent custom attribute displays associated with the portlet 1505 */ 1506 public void setCustomAttributesDisplayClasses( 1507 java.util.List<java.lang.String> customAttributesDisplayClasses); 1508 1509 /** 1510 * Sets the default plugin settings of the portlet. 1511 * 1512 * @param pluginSetting the plugin setting 1513 */ 1514 public void setDefaultPluginSetting( 1515 com.liferay.portal.model.PluginSetting pluginSetting); 1516 1517 /** 1518 * Sets the default preferences of the portlet. 1519 * 1520 * @param defaultPreferences the default preferences of the portlet 1521 */ 1522 public void setDefaultPreferences(java.lang.String defaultPreferences); 1523 1524 /** 1525 * Sets the display name of the portlet. 1526 * 1527 * @param displayName the display name of the portlet 1528 */ 1529 public void setDisplayName(java.lang.String displayName); 1530 1531 /** 1532 * Sets expiration cache of the portlet. 1533 * 1534 * @param expCache expiration cache of the portlet 1535 */ 1536 public void setExpCache(java.lang.Integer expCache); 1537 1538 /** 1539 * Sets the Facebook integration method of the portlet. 1540 * 1541 * @param facebookIntegration the Facebook integration method of the portlet 1542 */ 1543 public void setFacebookIntegration(java.lang.String facebookIntegration); 1544 1545 /** 1546 * Sets a list of CSS files that will be referenced from the page's footer 1547 * relative to the portal's context path. 1548 * 1549 * @param footerPortalCss a list of CSS files that will be referenced from 1550 the page's footer relative to the portal's context path 1551 */ 1552 public void setFooterPortalCss( 1553 java.util.List<java.lang.String> footerPortalCss); 1554 1555 /** 1556 * Sets a list of JavaScript files that will be referenced from the page's 1557 * footer relative to the portal's context path. 1558 * 1559 * @param footerPortalJavaScript a list of JavaScript files that will be 1560 referenced from the page's footer relative to the portal's context 1561 path 1562 */ 1563 public void setFooterPortalJavaScript( 1564 java.util.List<java.lang.String> footerPortalJavaScript); 1565 1566 /** 1567 * Sets a list of CSS files that will be referenced from the page's footer 1568 * relative to the portlet's context path. 1569 * 1570 * @param footerPortletCss a list of CSS files that will be referenced from 1571 the page's footer relative to the portlet's context path 1572 */ 1573 public void setFooterPortletCss( 1574 java.util.List<java.lang.String> footerPortletCss); 1575 1576 /** 1577 * Sets a list of JavaScript files that will be referenced from the page's 1578 * footer relative to the portlet's context path. 1579 * 1580 * @param footerPortletJavaScript a list of JavaScript files that will be 1581 referenced from the page's footer relative to the portlet's 1582 context path 1583 */ 1584 public void setFooterPortletJavaScript( 1585 java.util.List<java.lang.String> footerPortletJavaScript); 1586 1587 /** 1588 * Sets the name of the friendly URL mapper class of the portlet. 1589 * 1590 * @param friendlyURLMapperClass the name of the friendly URL mapper class 1591 of the portlet 1592 */ 1593 public void setFriendlyURLMapperClass( 1594 java.lang.String friendlyURLMapperClass); 1595 1596 /** 1597 * Sets the name of the friendly URL mapping of the portlet. 1598 * 1599 * @param friendlyURLMapping the name of the friendly URL mapping of the 1600 portlet 1601 */ 1602 public void setFriendlyURLMapping(java.lang.String friendlyURLMapping); 1603 1604 /** 1605 * Sets the class loader resource path to the friendly URL routes of the 1606 * portlet. 1607 * 1608 * @param friendlyURLRoutes the class loader resource path to the friendly 1609 URL routes of the portlet 1610 */ 1611 public void setFriendlyURLRoutes(java.lang.String friendlyURLRoutes); 1612 1613 /** 1614 * Sets a list of CSS files that will be referenced from the page's header 1615 * relative to the portal's context path. 1616 * 1617 * @param headerPortalCss a list of CSS files that will be referenced from 1618 the page's header relative to the portal's context path 1619 */ 1620 public void setHeaderPortalCss( 1621 java.util.List<java.lang.String> headerPortalCss); 1622 1623 /** 1624 * Sets a list of JavaScript files that will be referenced from the page's 1625 * header relative to the portal's context path. 1626 * 1627 * @param headerPortalJavaScript a list of JavaScript files that will be 1628 referenced from the page's header relative to the portal's context 1629 path 1630 */ 1631 public void setHeaderPortalJavaScript( 1632 java.util.List<java.lang.String> headerPortalJavaScript); 1633 1634 /** 1635 * Sets a list of CSS files that will be referenced from the page's header 1636 * relative to the portlet's context path. 1637 * 1638 * @param headerPortletCss a list of CSS files that will be referenced from 1639 the page's header relative to the portlet's context path 1640 */ 1641 public void setHeaderPortletCss( 1642 java.util.List<java.lang.String> headerPortletCss); 1643 1644 /** 1645 * Sets a list of JavaScript files that will be referenced from the page's 1646 * header relative to the portlet's context path. 1647 * 1648 * @param headerPortletJavaScript a list of JavaScript files that will be 1649 referenced from the page's header relative to the portlet's 1650 context path 1651 */ 1652 public void setHeaderPortletJavaScript( 1653 java.util.List<java.lang.String> headerPortletJavaScript); 1654 1655 /** 1656 * Sets the icon of the portlet. 1657 * 1658 * @param icon the icon of the portlet 1659 */ 1660 public void setIcon(java.lang.String icon); 1661 1662 /** 1663 * Set to <code>true</code> to include the portlet and make it available to 1664 * be made active. 1665 * 1666 * @param include boolean value for whether to include the portlet and make 1667 it available to be made active 1668 */ 1669 public void setInclude(boolean include); 1670 1671 /** 1672 * Sets the name of the classes that represent indexers associated with the 1673 * portlet. 1674 * 1675 * @param indexerClasses the name of the classes that represent indexers 1676 associated with the portlet 1677 */ 1678 public void setIndexerClasses( 1679 java.util.List<java.lang.String> indexerClasses); 1680 1681 /** 1682 * Sets the init parameters of the portlet. 1683 * 1684 * @param initParams the init parameters of the portlet 1685 */ 1686 public void setInitParams( 1687 java.util.Map<java.lang.String, java.lang.String> initParams); 1688 1689 /** 1690 * Set to <code>true</code> if the portlet can be added multiple times to a 1691 * layout. 1692 * 1693 * @param instanceable boolean value for whether the portlet can be added 1694 multiple times to a layout 1695 */ 1696 public void setInstanceable(boolean instanceable); 1697 1698 /** 1699 * Set to <code>true</code> to allow the portlet to be cached within the 1700 * layout. 1701 * 1702 * @param layoutCacheable boolean value for whether the portlet can be 1703 cached within the layout 1704 */ 1705 public void setLayoutCacheable(boolean layoutCacheable); 1706 1707 /** 1708 * Set to <code>true</code> if the portlet goes into the maximized state 1709 * when the user goes into the edit mode. 1710 * 1711 * @param maximizeEdit boolean value for whether the portlet goes into the 1712 maximized state when the user goes into the edit mode 1713 */ 1714 public void setMaximizeEdit(boolean maximizeEdit); 1715 1716 /** 1717 * Set to <code>true</code> if the portlet goes into the maximized state 1718 * when the user goes into the help mode. 1719 * 1720 * @param maximizeHelp boolean value for whether the portlet goes into the 1721 maximized state when the user goes into the help mode 1722 */ 1723 public void setMaximizeHelp(boolean maximizeHelp); 1724 1725 /** 1726 * Sets the name of the open search class of the portlet. 1727 * 1728 * @param openSearchClass the name of the open search class of the portlet 1729 */ 1730 public void setOpenSearchClass(java.lang.String openSearchClass); 1731 1732 /** 1733 * Sets the parent struts path of the portlet. 1734 * 1735 * @param parentStrutsPath the parent struts path of the portlet 1736 */ 1737 public void setParentStrutsPath(java.lang.String parentStrutsPath); 1738 1739 /** 1740 * Sets the name of the permission propagator class of the portlet. 1741 */ 1742 public void setPermissionPropagatorClass( 1743 java.lang.String permissionPropagatorClass); 1744 1745 /** 1746 * Sets this portlet's plugin package. 1747 * 1748 * @param pluginPackage this portlet's plugin package 1749 */ 1750 public void setPluginPackage( 1751 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage); 1752 1753 /** 1754 * Sets the name of the poller processor class of the portlet. 1755 * 1756 * @param pollerProcessorClass the name of the poller processor class of the 1757 portlet 1758 */ 1759 public void setPollerProcessorClass(java.lang.String pollerProcessorClass); 1760 1761 /** 1762 * Sets the name of the POP message listener class of the portlet. 1763 * 1764 * @param popMessageListenerClass the name of the POP message listener class 1765 of the portlet 1766 */ 1767 public void setPopMessageListenerClass( 1768 java.lang.String popMessageListenerClass); 1769 1770 /** 1771 * Set to <code>true</code> if the portlet goes into the pop up state when 1772 * the user goes into the print mode. 1773 * 1774 * @param popUpPrint boolean value for whether the portlet goes into the pop 1775 up state when the user goes into the print mode 1776 */ 1777 public void setPopUpPrint(boolean popUpPrint); 1778 1779 /** 1780 * Sets this portlet's application. 1781 * 1782 * @param portletApp this portlet's application 1783 */ 1784 public void setPortletApp(com.liferay.portal.model.PortletApp portletApp); 1785 1786 /** 1787 * Sets the name of the portlet class of the portlet. 1788 * 1789 * @param portletClass the name of the portlet class of the portlet 1790 */ 1791 public void setPortletClass(java.lang.String portletClass); 1792 1793 /** 1794 * Sets the name of the portlet data handler class of the portlet. 1795 * 1796 * @param portletDataHandlerClass the name of portlet data handler class of 1797 the portlet 1798 */ 1799 public void setPortletDataHandlerClass( 1800 java.lang.String portletDataHandlerClass); 1801 1802 /** 1803 * Sets the name of the portlet display template handler class of the 1804 * portlet. 1805 * 1806 * @param portletDisplayTemplateHandlerClass the name of display template 1807 handler class of the portlet 1808 */ 1809 public void setPortletDisplayTemplateHandlerClass( 1810 java.lang.String portletDisplayTemplateHandlerClass); 1811 1812 /** 1813 * Sets the filters of the portlet. 1814 * 1815 * @param portletFilters the filters of the portlet 1816 */ 1817 public void setPortletFilters( 1818 java.util.Map<java.lang.String, com.liferay.portal.model.PortletFilter> portletFilters); 1819 1820 /** 1821 * Sets the portlet info of the portlet. 1822 * 1823 * @param portletInfo the portlet info of the portlet 1824 */ 1825 public void setPortletInfo(com.liferay.portal.model.PortletInfo portletInfo); 1826 1827 /** 1828 * Sets the name of the portlet layout listener class of the portlet. 1829 * 1830 * @param portletLayoutListenerClass the name of the portlet layout listener 1831 class of the portlet 1832 */ 1833 public void setPortletLayoutListenerClass( 1834 java.lang.String portletLayoutListenerClass); 1835 1836 /** 1837 * Sets the portlet modes of the portlet. 1838 * 1839 * @param portletModes the portlet modes of the portlet 1840 */ 1841 public void setPortletModes( 1842 java.util.Map<java.lang.String, java.util.Set<java.lang.String>> portletModes); 1843 1844 /** 1845 * Sets the name of the portlet. 1846 * 1847 * @param portletName the name of the portlet 1848 */ 1849 public void setPortletName(java.lang.String portletName); 1850 1851 /** 1852 * Sets the name of the portlet URL class of the portlet. 1853 * 1854 * @param portletURLClass the name of the portlet URL class of the portlet 1855 */ 1856 public void setPortletURLClass(java.lang.String portletURLClass); 1857 1858 /** 1859 * Set to <code>true</code> if preferences are shared across the entire 1860 * company. 1861 * 1862 * @param preferencesCompanyWide boolean value for whether preferences are 1863 shared across the entire company 1864 */ 1865 public void setPreferencesCompanyWide(boolean preferencesCompanyWide); 1866 1867 /** 1868 * Set to <code>true</code> if preferences are owned by the group when the 1869 * portlet is shown in a group layout. Set to <code>false</code> if 1870 * preferences are owned by the user at all times. 1871 * 1872 * @param preferencesOwnedByGroup boolean value for whether preferences are 1873 owned by the group when the portlet is shown in a group layout or 1874 preferences are owned by the user at all times 1875 */ 1876 public void setPreferencesOwnedByGroup(boolean preferencesOwnedByGroup); 1877 1878 /** 1879 * Set to <code>true</code> if preferences are unique per layout. 1880 * 1881 * @param preferencesUniquePerLayout boolean value for whether preferences 1882 are unique per layout 1883 */ 1884 public void setPreferencesUniquePerLayout( 1885 boolean preferencesUniquePerLayout); 1886 1887 /** 1888 * Sets the name of the preferences validator class of the portlet. 1889 * 1890 * @param preferencesValidator the name of the preferences validator class 1891 of the portlet 1892 */ 1893 public void setPreferencesValidator(java.lang.String preferencesValidator); 1894 1895 /** 1896 * Set to <code>true</code> if the portlet does not share request attributes 1897 * with the portal or portlets from another WAR. 1898 * 1899 * @param privateRequestAttributes boolean value for whether the portlet 1900 shares request attributes with the portal or portlets from another 1901 WAR 1902 */ 1903 public void setPrivateRequestAttributes(boolean privateRequestAttributes); 1904 1905 /** 1906 * Set to <code>true</code> if the portlet does not share session attributes 1907 * with the portal. 1908 * 1909 * @param privateSessionAttributes boolean value for whether the portlet 1910 shares session attributes with the portal 1911 */ 1912 public void setPrivateSessionAttributes(boolean privateSessionAttributes); 1913 1914 /** 1915 * Sets the supported processing events of the portlet. 1916 * 1917 * @param processingEvents the supported processing events of the portlet 1918 */ 1919 public void setProcessingEvents( 1920 java.util.Set<com.liferay.portal.kernel.xml.QName> processingEvents); 1921 1922 /** 1923 * Sets the supported public render parameters of the portlet. 1924 * 1925 * @param publicRenderParameters the supported public render parameters of 1926 the portlet 1927 */ 1928 public void setPublicRenderParameters( 1929 java.util.Set<com.liferay.portal.model.PublicRenderParameter> publicRenderParameters); 1930 1931 /** 1932 * Sets the supported publishing events of the portlet. 1933 * 1934 * @param publishingEvents the supported publishing events of the portlet 1935 */ 1936 public void setPublishingEvents( 1937 java.util.Set<com.liferay.portal.kernel.xml.QName> publishingEvents); 1938 1939 /** 1940 * Set to <code>true</code> if the portlet is ready to be used. 1941 * 1942 * @param ready whether the portlet is ready to be used 1943 */ 1944 public void setReady(boolean ready); 1945 1946 /** 1947 * Set to <code>true</code> if the portlet supports remoting 1948 * 1949 * @param remoteable boolean value for whether or not the the portlet 1950 supports remoting 1951 */ 1952 public void setRemoteable(boolean remoteable); 1953 1954 /** 1955 * Sets the render timeout of the portlet. 1956 * 1957 * @param renderTimeout the render timeout of the portlet 1958 */ 1959 public void setRenderTimeout(int renderTimeout); 1960 1961 /** 1962 * Sets the render weight of the portlet. 1963 * 1964 * @param renderWeight int value for the render weight of the portlet 1965 */ 1966 public void setRenderWeight(int renderWeight); 1967 1968 /** 1969 * Sets the resource bundle of the portlet. 1970 * 1971 * @param resourceBundle the resource bundle of the portlet 1972 */ 1973 public void setResourceBundle(java.lang.String resourceBundle); 1974 1975 /** 1976 * Set to <code>true</code> if the portlet restores to the current view from 1977 * the maximized state. 1978 * 1979 * @param restoreCurrentView boolean value for whether the portlet restores 1980 to the current view from the maximized state 1981 */ 1982 public void setRestoreCurrentView(boolean restoreCurrentView); 1983 1984 /** 1985 * Sets the role mappers of the portlet. 1986 * 1987 * @param roleMappers the role mappers of the portlet 1988 */ 1989 public void setRoleMappers( 1990 java.util.Map<java.lang.String, java.lang.String> roleMappers); 1991 1992 /** 1993 * Sets a string of ordered comma delimited portlet IDs. 1994 * 1995 * @param roles a string of ordered comma delimited portlet IDs 1996 */ 1997 public void setRoles(java.lang.String roles); 1998 1999 /** 2000 * Sets an array of required roles of the portlet. 2001 * 2002 * @param rolesArray an array of required roles of the portlet 2003 */ 2004 public void setRolesArray(java.lang.String[] rolesArray); 2005 2006 /** 2007 * Sets the scheduler entries of the portlet. 2008 * 2009 * @param schedulerEntries the scheduler entries of the portlet 2010 */ 2011 public void setSchedulerEntries( 2012 java.util.List<com.liferay.portal.kernel.scheduler.SchedulerEntry> schedulerEntries); 2013 2014 /** 2015 * Set to <code>true</code> if the portlet supports scoping of data. 2016 * 2017 * @param scopeable boolean value for whether or not the the portlet 2018 supports scoping of data 2019 */ 2020 public void setScopeable(boolean scopeable); 2021 2022 /** 2023 * Set to <code>true</code> if users are shown that they do not have access 2024 * to the portlet. 2025 * 2026 * @param showPortletAccessDenied boolean value for whether users are shown 2027 that they do not have access to the portlet 2028 */ 2029 public void setShowPortletAccessDenied(boolean showPortletAccessDenied); 2030 2031 /** 2032 * Set to <code>true</code> if users are shown that the portlet is inactive. 2033 * 2034 * @param showPortletInactive boolean value for whether users are shown that 2035 the portlet is inactive 2036 */ 2037 public void setShowPortletInactive(boolean showPortletInactive); 2038 2039 /** 2040 * Sets the name of the social activity interpreter class of the portlet. 2041 * 2042 * @param socialActivityInterpreterClass the name of the activity 2043 interpreter class of the portlet 2044 */ 2045 public void setSocialActivityInterpreterClass( 2046 java.lang.String socialActivityInterpreterClass); 2047 2048 /** 2049 * Sets the name of the social request interpreter class of the portlet. 2050 * 2051 * @param socialRequestInterpreterClass the name of the request interpreter 2052 class of the portlet 2053 */ 2054 public void setSocialRequestInterpreterClass( 2055 java.lang.String socialRequestInterpreterClass); 2056 2057 /** 2058 * Set to <code>true</code> if the portlet is a static portlet that is 2059 * cannot be moved. 2060 * 2061 * @param staticPortlet boolean value for whether the portlet is a static 2062 portlet that cannot be moved 2063 */ 2064 public void setStatic(boolean staticPortlet); 2065 2066 /** 2067 * Set to <code>true</code> if the portlet is a static portlet at the start 2068 * of a list of portlets. 2069 * 2070 * @param staticPortletStart boolean value for whether the portlet is a 2071 static portlet at the start of a list of portlets 2072 */ 2073 public void setStaticStart(boolean staticPortletStart); 2074 2075 /** 2076 * Sets the struts path of the portlet. 2077 * 2078 * @param strutsPath the struts path of the portlet 2079 */ 2080 public void setStrutsPath(java.lang.String strutsPath); 2081 2082 /** 2083 * Sets the supported locales of the portlet. 2084 * 2085 * @param supportedLocales the supported locales of the portlet 2086 */ 2087 public void setSupportedLocales( 2088 java.util.Set<java.lang.String> supportedLocales); 2089 2090 /** 2091 * Set to <code>true</code> if the portlet is a system portlet that a user 2092 * cannot manually add to their page. 2093 * 2094 * @param system boolean value for whether the portlet is a system portlet 2095 that a user cannot manually add to their page 2096 */ 2097 public void setSystem(boolean system); 2098 2099 /** 2100 * Sets the timestamp of the portlet. 2101 * 2102 * @param timestamp the timestamp of the portlet 2103 */ 2104 public void setTimestamp(long timestamp); 2105 2106 /** 2107 * Sets the name of the classes that represent trash handlers associated to 2108 * the portlet. 2109 * 2110 * @param trashHandlerClasses the names of the classes that represent trash 2111 handlers associated with the portlet 2112 */ 2113 public void setTrashHandlerClasses( 2114 java.util.List<java.lang.String> trashHandlerClasses); 2115 2116 /** 2117 * Set to <code>true</code> if the portlet is an undeployed portlet. 2118 * 2119 * @param undeployedPortlet boolean value for whether the portlet is an 2120 undeployed portlet 2121 */ 2122 public void setUndeployedPortlet(boolean undeployedPortlet); 2123 2124 /** 2125 * Sets the unlinked roles of the portlet. 2126 * 2127 * @param unlinkedRoles the unlinked roles of the portlet 2128 */ 2129 public void setUnlinkedRoles(java.util.Set<java.lang.String> unlinkedRoles); 2130 2131 /** 2132 * Sets the name of the URL encoder class of the portlet. 2133 * 2134 * @param urlEncoderClass the name of the URL encoder class of the portlet 2135 */ 2136 public void setURLEncoderClass(java.lang.String urlEncoderClass); 2137 2138 /** 2139 * Set to <code>true</code> if the portlet uses the default template. 2140 * 2141 * @param useDefaultTemplate boolean value for whether the portlet uses the 2142 default template 2143 */ 2144 public void setUseDefaultTemplate(boolean useDefaultTemplate); 2145 2146 /** 2147 * Sets the user principal strategy of the portlet. 2148 * 2149 * @param userPrincipalStrategy the user principal strategy of the portlet 2150 */ 2151 public void setUserPrincipalStrategy(java.lang.String userPrincipalStrategy); 2152 2153 /** 2154 * Sets the virtual path of the portlet. 2155 * 2156 * @param virtualPath the virtual path of the portlet 2157 */ 2158 public void setVirtualPath(java.lang.String virtualPath); 2159 2160 /** 2161 * Sets the name of the WebDAV storage class of the portlet. 2162 * 2163 * @param webDAVStorageClass the name of the WebDAV storage class of the 2164 portlet 2165 */ 2166 public void setWebDAVStorageClass(java.lang.String webDAVStorageClass); 2167 2168 /** 2169 * Sets the name of the WebDAV storage token of the portlet. 2170 * 2171 * @param webDAVStorageToken the name of the WebDAV storage token of the 2172 portlet 2173 */ 2174 public void setWebDAVStorageToken(java.lang.String webDAVStorageToken); 2175 2176 /** 2177 * Sets the window states of the portlet. 2178 * 2179 * @param windowStates the window states of the portlet 2180 */ 2181 public void setWindowStates( 2182 java.util.Map<java.lang.String, java.util.Set<java.lang.String>> windowStates); 2183 2184 /** 2185 * Sets the name of the classes that represent workflow handlers associated 2186 * to the portlet. 2187 * 2188 * @param workflowHandlerClasses the names of the classes that represent 2189 workflow handlers associated with the portlet 2190 */ 2191 public void setWorkflowHandlerClasses( 2192 java.util.List<java.lang.String> workflowHandlerClasses); 2193 2194 /** 2195 * Sets the name of the XML-RPC method class of the portlet. 2196 * 2197 * @param xmlRpcMethodClass the name of the XML-RPC method class of the 2198 portlet 2199 */ 2200 public void setXmlRpcMethodClass(java.lang.String xmlRpcMethodClass); 2201 }