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