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