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