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