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