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