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