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