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