001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 /** 020 * Provides a wrapper for {@link GroupService}. 021 * 022 * @author Brian Wing Shun Chan 023 * @see GroupService 024 * @generated 025 */ 026 @ProviderType 027 public class GroupServiceWrapper implements GroupService, 028 ServiceWrapper<GroupService> { 029 public GroupServiceWrapper(GroupService groupService) { 030 _groupService = groupService; 031 } 032 033 /** 034 * @deprecated As of 6.2.0, replaced by {@link #addGroup(long, String, 035 String, int, String, boolean, boolean, ServiceContext)} 036 */ 037 @Deprecated 038 @Override 039 public com.liferay.portal.model.Group addGroup(java.lang.String name, 040 java.lang.String description, int type, java.lang.String friendlyURL, 041 boolean site, boolean active, 042 com.liferay.portal.service.ServiceContext serviceContext) 043 throws com.liferay.portal.kernel.exception.PortalException { 044 return _groupService.addGroup(name, description, type, friendlyURL, 045 site, active, serviceContext); 046 } 047 048 /** 049 * Adds a group. 050 * 051 * @param parentGroupId the primary key of the parent group 052 * @param liveGroupId the primary key of the live group 053 * @param name the entity's name 054 * @param description the group's description (optionally 055 <code>null</code>) 056 * @param type the group's type. For more information see {@link 057 GroupConstants}. 058 * @param manualMembership whether manual membership is allowed for the 059 group 060 * @param membershipRestriction the group's membership restriction. For 061 more information see {@link GroupConstants}. 062 * @param friendlyURL the group's friendlyURL (optionally 063 <code>null</code>) 064 * @param site whether the group is to be associated with a main site 065 * @param active whether the group is active 066 * @param serviceContext the service context to be applied (optionally 067 <code>null</code>). Can set the asset category IDs and asset 068 tag names for the group, and can set whether the group is for 069 staging 070 * @return the group 071 * @throws PortalException if the user did not have permission to add 072 the group, if a creator could not be found, if the group's 073 information was invalid, if a layout could not be found, or 074 if a valid friendly URL could not be created for the group 075 * @deprecated As of 7.0.0, replaced by {@link #addGroup(long, long, Map, 076 Map, int, boolean, int, String, boolean, boolean, 077 ServiceContext)} 078 */ 079 @Deprecated 080 @Override 081 public com.liferay.portal.model.Group addGroup(long parentGroupId, 082 long liveGroupId, java.lang.String name, java.lang.String description, 083 int type, boolean manualMembership, int membershipRestriction, 084 java.lang.String friendlyURL, boolean site, boolean active, 085 com.liferay.portal.service.ServiceContext serviceContext) 086 throws com.liferay.portal.kernel.exception.PortalException { 087 return _groupService.addGroup(parentGroupId, liveGroupId, name, 088 description, type, manualMembership, membershipRestriction, 089 friendlyURL, site, active, serviceContext); 090 } 091 092 @Override 093 public com.liferay.portal.model.Group addGroup(long parentGroupId, 094 long liveGroupId, 095 java.util.Map<java.util.Locale, java.lang.String> nameMap, 096 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 097 int type, boolean manualMembership, int membershipRestriction, 098 java.lang.String friendlyURL, boolean site, boolean active, 099 com.liferay.portal.service.ServiceContext serviceContext) 100 throws com.liferay.portal.kernel.exception.PortalException { 101 return _groupService.addGroup(parentGroupId, liveGroupId, nameMap, 102 descriptionMap, type, manualMembership, membershipRestriction, 103 friendlyURL, site, active, serviceContext); 104 } 105 106 @Override 107 public com.liferay.portal.model.Group addGroup(long parentGroupId, 108 long liveGroupId, 109 java.util.Map<java.util.Locale, java.lang.String> nameMap, 110 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 111 int type, boolean manualMembership, int membershipRestriction, 112 java.lang.String friendlyURL, boolean site, boolean inheritContent, 113 boolean active, com.liferay.portal.service.ServiceContext serviceContext) 114 throws com.liferay.portal.kernel.exception.PortalException { 115 return _groupService.addGroup(parentGroupId, liveGroupId, nameMap, 116 descriptionMap, type, manualMembership, membershipRestriction, 117 friendlyURL, site, inheritContent, active, serviceContext); 118 } 119 120 /** 121 * Adds the group using the group default live group ID. 122 * 123 * @param parentGroupId the primary key of the parent group 124 * @param name the entity's name 125 * @param description the group's description (optionally 126 <code>null</code>) 127 * @param type the group's type. For more information see {@link 128 GroupConstants}. 129 * @param friendlyURL the group's friendlyURL 130 * @param site whether the group is to be associated with a main site 131 * @param active whether the group is active 132 * @param serviceContext the service context to be applied (optionally 133 <code>null</code>). Can set asset category IDs and asset tag 134 names for the group, and can set whether the group is for 135 staging 136 * @return the group 137 * @throws PortalException if the user did not have permission to add 138 the group, if a creator could not be found, if the group's 139 information was invalid, if a layout could not be found, or 140 if a valid friendly URL could not be created for the group 141 * @deprecated As of 6.2.0, replaced by {@link #addGroup(long, long, Map, 142 Map, int, boolean, int, String, boolean, boolean, 143 ServiceContext)} 144 */ 145 @Deprecated 146 @Override 147 public com.liferay.portal.model.Group addGroup(long parentGroupId, 148 java.lang.String name, java.lang.String description, int type, 149 java.lang.String friendlyURL, boolean site, boolean active, 150 com.liferay.portal.service.ServiceContext serviceContext) 151 throws com.liferay.portal.kernel.exception.PortalException { 152 return _groupService.addGroup(parentGroupId, name, description, type, 153 friendlyURL, site, active, serviceContext); 154 } 155 156 /** 157 * Adds the groups to the role. 158 * 159 * @param roleId the primary key of the role 160 * @param groupIds the primary keys of the groups 161 * @throws PortalException if the user did not have permission to update the 162 role 163 */ 164 @Override 165 public void addRoleGroups(long roleId, long[] groupIds) 166 throws com.liferay.portal.kernel.exception.PortalException { 167 _groupService.addRoleGroups(roleId, groupIds); 168 } 169 170 /** 171 * Checks that the current user is permitted to use the group for Remote 172 * Staging. 173 * 174 * @param groupId the primary key of the group 175 * @throws PortalException if a group with the primary key could not be 176 found, if the current user did not have permission to view the 177 group, or if the group's company was different from the current 178 user's company 179 */ 180 @Override 181 public void checkRemoteStagingGroup(long groupId) 182 throws com.liferay.portal.kernel.exception.PortalException { 183 _groupService.checkRemoteStagingGroup(groupId); 184 } 185 186 /** 187 * Deletes the group. 188 * 189 * <p> 190 * The group is unstaged and its assets and resources including layouts, 191 * membership requests, subscriptions, teams, blogs, bookmarks, calendar 192 * events, image gallery, journals, message boards, polls, shopping related 193 * entities, software catalog, and wikis are also deleted. 194 * </p> 195 * 196 * @param groupId the primary key of the group 197 * @throws PortalException if the user did not have permission to delete the 198 group or its assets or resources, if a group with the primary key 199 could not be found, or if the group was a system group 200 */ 201 @Override 202 public void deleteGroup(long groupId) 203 throws com.liferay.portal.kernel.exception.PortalException { 204 _groupService.deleteGroup(groupId); 205 } 206 207 @Override 208 public void disableStaging(long groupId) 209 throws com.liferay.portal.kernel.exception.PortalException { 210 _groupService.disableStaging(groupId); 211 } 212 213 @Override 214 public void enableStaging(long groupId) 215 throws com.liferay.portal.kernel.exception.PortalException { 216 _groupService.enableStaging(groupId); 217 } 218 219 /** 220 * Returns the Spring bean ID for this bean. 221 * 222 * @return the Spring bean ID for this bean 223 */ 224 @Override 225 public java.lang.String getBeanIdentifier() { 226 return _groupService.getBeanIdentifier(); 227 } 228 229 /** 230 * Returns the company group. 231 * 232 * @param companyId the primary key of the company 233 * @return the group associated with the company 234 * @throws PortalException if a matching group could not be found 235 */ 236 @Override 237 public com.liferay.portal.model.Group getCompanyGroup(long companyId) 238 throws com.liferay.portal.kernel.exception.PortalException { 239 return _groupService.getCompanyGroup(companyId); 240 } 241 242 /** 243 * Returns the group with the name. 244 * 245 * @param companyId the primary key of the company 246 * @param groupKey the group key 247 * @return the group with the group key 248 * @throws PortalException if a matching group could not be found or if the 249 current user did not have permission to view the group 250 */ 251 @Override 252 public com.liferay.portal.model.Group getGroup(long companyId, 253 java.lang.String groupKey) 254 throws com.liferay.portal.kernel.exception.PortalException { 255 return _groupService.getGroup(companyId, groupKey); 256 } 257 258 /** 259 * Returns the group with the primary key. 260 * 261 * @param groupId the primary key of the group 262 * @return the group with the primary key 263 * @throws PortalException if a group with the primary key could not be 264 found or if the current user did not have permission to view the 265 group 266 */ 267 @Override 268 public com.liferay.portal.model.Group getGroup(long groupId) 269 throws com.liferay.portal.kernel.exception.PortalException { 270 return _groupService.getGroup(groupId); 271 } 272 273 /** 274 * Returns all the groups that are direct children of the parent group. 275 * 276 * @param companyId the primary key of the company 277 * @param parentGroupId the primary key of the parent group 278 * @param site whether the group is to be associated with a main site 279 * @return the matching groups, or <code>null</code> if no matches were 280 found 281 * @throws PortalException if the user did not have permission to view the 282 group or if a portal exception occurred 283 */ 284 @Override 285 public java.util.List<com.liferay.portal.model.Group> getGroups( 286 long companyId, long parentGroupId, boolean site) 287 throws com.liferay.portal.kernel.exception.PortalException { 288 return _groupService.getGroups(companyId, parentGroupId, site); 289 } 290 291 /** 292 * Returns a range of all the site groups for which the user has control 293 * panel access. 294 * 295 * @param portlets the portlets to manage 296 * @param max the upper bound of the range of groups to consider (not 297 inclusive) 298 * @return the range of site groups for which the user has Control Panel 299 access 300 * @throws PortalException if a portal exception occurred 301 */ 302 @Override 303 public java.util.List<com.liferay.portal.model.Group> getManageableSiteGroups( 304 java.util.Collection<com.liferay.portal.model.Portlet> portlets, int max) 305 throws com.liferay.portal.kernel.exception.PortalException { 306 return _groupService.getManageableSiteGroups(portlets, max); 307 } 308 309 /** 310 * Returns a range of all the site groups for which the user has control 311 * panel access. 312 * 313 * @param portlets the portlets to manage 314 * @param max the upper bound of the range of groups to consider (not 315 inclusive) 316 * @return the range of site groups for which the user has Control Panel 317 access 318 * @throws PortalException if a portal exception occurred 319 * @deprecated As of 6.2.0, replaced by {@link 320 #getManageableSiteGroups(Collection, int)} 321 */ 322 @Deprecated 323 @Override 324 public java.util.List<com.liferay.portal.model.Group> getManageableSites( 325 java.util.Collection<com.liferay.portal.model.Portlet> portlets, int max) 326 throws com.liferay.portal.kernel.exception.PortalException { 327 return _groupService.getManageableSites(portlets, max); 328 } 329 330 /** 331 * Returns the groups associated with the organizations. 332 * 333 * @param organizations the organizations 334 * @return the groups associated with the organizations 335 * @throws PortalException if a portal exception occurred 336 */ 337 @Override 338 public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups( 339 java.util.List<com.liferay.portal.model.Organization> organizations) 340 throws com.liferay.portal.kernel.exception.PortalException { 341 return _groupService.getOrganizationsGroups(organizations); 342 } 343 344 /** 345 * Returns the group directly associated with the user. 346 * 347 * @param companyId the primary key of the company 348 * @param userId the primary key of the user 349 * @return the group directly associated with the user 350 * @throws PortalException if a matching group could not be found or if the 351 current user did not have permission to view the group 352 */ 353 @Override 354 public com.liferay.portal.model.Group getUserGroup(long companyId, 355 long userId) throws com.liferay.portal.kernel.exception.PortalException { 356 return _groupService.getUserGroup(companyId, userId); 357 } 358 359 /** 360 * Returns the groups associated with the user groups. 361 * 362 * @param userGroups the user groups 363 * @return the groups associated with the user groups 364 * @throws PortalException if any one of the user group's group could not be 365 found 366 */ 367 @Override 368 public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups( 369 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 370 throws com.liferay.portal.kernel.exception.PortalException { 371 return _groupService.getUserGroupsGroups(userGroups); 372 } 373 374 /** 375 * Returns the range of all groups associated with the user's organization 376 * groups, including the ancestors of the organization groups, unless portal 377 * property <code>organizations.membership.strict</code> is set to 378 * <code>true</code>. 379 * 380 * <p> 381 * Useful when paginating results. Returns a maximum of <code>end - 382 * start</code> instances. <code>start</code> and <code>end</code> are not 383 * primary keys, they are indexes in the result set. Thus, <code>0</code> 384 * refers to the first result in the set. Setting both <code>start</code> 385 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 386 * result set. 387 * </p> 388 * 389 * @param userId the primary key of the user 390 * @param start the lower bound of the range of groups to consider 391 * @param end the upper bound of the range of groups to consider (not 392 inclusive) 393 * @return the range of groups associated with the user's organizations 394 * @throws PortalException if a user with the primary key could not be found 395 or if another portal exception occurred 396 */ 397 @Override 398 public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups( 399 long userId, int start, int end) 400 throws com.liferay.portal.kernel.exception.PortalException { 401 return _groupService.getUserOrganizationsGroups(userId, start, end); 402 } 403 404 /** 405 * Returns the guest or current user's groups "sites" associated 406 * with the group entity class names, including the Control Panel group if 407 * the user is permitted to view the Control Panel. 408 * 409 * <ul> 410 * <li> 411 * Class name "User" includes the user's layout set 412 * group. 413 * </li> 414 * <li> 415 * Class name "Organization" includes the user's 416 * immediate organization groups and inherited organization groups. 417 * </li> 418 * <li> 419 * Class name "Group" includes the user's immediate 420 * organization groups and site groups. 421 * </li> 422 * <li> 423 * A <code>classNames</code> 424 * value of <code>null</code> includes the user's layout set group, 425 * organization groups, inherited organization groups, and site groups. 426 * </li> 427 * </ul> 428 * 429 * @param classNames the group entity class names (optionally 430 <code>null</code>). For more information see {@link 431 #getUserSitesGroups(String[], int)}. 432 * @param max the maximum number of groups to return 433 * @return the user's groups "sites" 434 * @throws PortalException if a portal exception occurred 435 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(String[], 436 int)} 437 */ 438 @Deprecated 439 @Override 440 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 441 java.lang.String[] classNames, int max) 442 throws com.liferay.portal.kernel.exception.PortalException { 443 return _groupService.getUserPlaces(classNames, max); 444 } 445 446 /** 447 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(long, 448 String[], int)} 449 */ 450 @Deprecated 451 @Override 452 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 453 long userId, java.lang.String[] classNames, 454 boolean includeControlPanel, int max) 455 throws com.liferay.portal.kernel.exception.PortalException { 456 return _groupService.getUserPlaces(userId, classNames, 457 includeControlPanel, max); 458 } 459 460 /** 461 * Returns the user's groups "sites" associated with the group 462 * entity class names, including the Control Panel group if the user is 463 * permitted to view the Control Panel. 464 * 465 * <ul> 466 * <li> 467 * Class name "User" includes the user's layout set 468 * group. 469 * </li> 470 * <li> 471 * Class name "Organization" includes the user's 472 * immediate organization groups and inherited organization groups. 473 * </li> 474 * <li> 475 * Class name "Group" includes the user's immediate 476 * organization groups and site groups. 477 * </li> 478 * <li> 479 * A <code>classNames</code> 480 * value of <code>null</code> includes the user's layout set group, 481 * organization groups, inherited organization groups, and site groups. 482 * </li> 483 * </ul> 484 * 485 * @param userId the primary key of the user 486 * @param classNames the group entity class names (optionally 487 <code>null</code>). For more information see {@link 488 #getUserSitesGroups(long, String[], int)}. 489 * @param max the maximum number of groups to return 490 * @return the user's groups "sites" 491 * @throws PortalException if a portal exception occurred 492 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(long, 493 String[], int)} 494 */ 495 @Deprecated 496 @Override 497 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 498 long userId, java.lang.String[] classNames, int max) 499 throws com.liferay.portal.kernel.exception.PortalException { 500 return _groupService.getUserPlaces(userId, classNames, max); 501 } 502 503 /** 504 * Returns the number of the guest or current user's groups 505 * "sites" associated with the group entity class names, including 506 * the Control Panel group if the user is permitted to view the Control 507 * Panel. 508 * 509 * @return the number of user's groups "sites" 510 * @throws PortalException if a portal exception occurred 511 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroupsCount()} 512 */ 513 @Deprecated 514 @Override 515 public int getUserPlacesCount() 516 throws com.liferay.portal.kernel.exception.PortalException { 517 return _groupService.getUserPlacesCount(); 518 } 519 520 /** 521 * Returns the guest or current user's layout set group, organization 522 * groups, inherited organization groups, and site groups. 523 * 524 * @return the user's layout set group, organization groups, and 525 inherited organization groups, and site groups 526 * @throws PortalException if a portal exception occurred 527 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups} 528 */ 529 @Deprecated 530 @Override 531 public java.util.List<com.liferay.portal.model.Group> getUserSites() 532 throws com.liferay.portal.kernel.exception.PortalException { 533 return _groupService.getUserSites(); 534 } 535 536 @Override 537 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups() 538 throws com.liferay.portal.kernel.exception.PortalException { 539 return _groupService.getUserSitesGroups(); 540 } 541 542 /** 543 * Returns the guest or current user's groups "sites" associated 544 * with the group entity class names, including the Control Panel group if 545 * the user is permitted to view the Control Panel. 546 * 547 * <ul> 548 * <li> 549 * Class name "User" includes the user's layout set 550 * group. 551 * </li> 552 * <li> 553 * Class name "Organization" includes the user's 554 * immediate organization groups and inherited organization groups. 555 * </li> 556 * <li> 557 * Class name "Group" includes the user's immediate 558 * organization groups and site groups. 559 * </li> 560 * <li> 561 * A <code>classNames</code> 562 * value of <code>null</code> includes the user's layout set group, 563 * organization groups, inherited organization groups, and site groups. 564 * </li> 565 * </ul> 566 * 567 * @param classNames the group entity class names (optionally 568 <code>null</code>). For more information see {@link 569 #getUserSitesGroups(long, String[], int)}. 570 * @param max the maximum number of groups to return 571 * @return the user's groups "sites" 572 * @throws PortalException if a portal exception occurred 573 */ 574 @Override 575 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups( 576 java.lang.String[] classNames, int max) 577 throws com.liferay.portal.kernel.exception.PortalException { 578 return _groupService.getUserSitesGroups(classNames, max); 579 } 580 581 /** 582 * Returns the user's groups "sites" associated with the group 583 * entity class names, including the Control Panel group if the user is 584 * permitted to view the Control Panel. 585 * 586 * <ul> 587 * <li> 588 * Class name "User" includes the user's layout set 589 * group. 590 * </li> 591 * <li> 592 * Class name "Organization" includes the user's 593 * immediate organization groups and inherited organization groups. 594 * </li> 595 * <li> 596 * Class name "Group" includes the user's immediate 597 * organization groups and site groups. 598 * </li> 599 * <li> 600 * A <code>classNames</code> 601 * value of <code>null</code> includes the user's layout set group, 602 * organization groups, inherited organization groups, and site groups. 603 * </li> 604 * </ul> 605 * 606 * @param userId the primary key of the user 607 * @param classNames the group entity class names (optionally 608 <code>null</code>). For more information see {@link 609 #getUserSitesGroups(long, String[], int)}. 610 * @param max the maximum number of groups to return 611 * @return the user's groups "sites" 612 * @throws PortalException if a portal exception occurred 613 */ 614 @Override 615 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups( 616 long userId, java.lang.String[] classNames, int max) 617 throws com.liferay.portal.kernel.exception.PortalException { 618 return _groupService.getUserSitesGroups(userId, classNames, max); 619 } 620 621 /** 622 * Returns the number of the guest or current user's groups 623 * "sites" associated with the group entity class names, including 624 * the Control Panel group if the user is permitted to view the Control 625 * Panel. 626 * 627 * @return the number of user's groups "sites" 628 * @throws PortalException if a portal exception occurred 629 */ 630 @Override 631 public int getUserSitesGroupsCount() 632 throws com.liferay.portal.kernel.exception.PortalException { 633 return _groupService.getUserSitesGroupsCount(); 634 } 635 636 /** 637 * Returns <code>true</code> if the user is associated with the group, 638 * including the user's inherited organizations and user groups. System and 639 * staged groups are not included. 640 * 641 * @param userId the primary key of the user 642 * @param groupId the primary key of the group 643 * @return <code>true</code> if the user is associated with the group; 644 <code>false</code> otherwise 645 * @throws PortalException if the current user did not have permission to 646 view the user or group members 647 */ 648 @Override 649 public boolean hasUserGroup(long userId, long groupId) 650 throws com.liferay.portal.kernel.exception.PortalException { 651 return _groupService.hasUserGroup(userId, groupId); 652 } 653 654 @Override 655 public java.util.List<com.liferay.portal.model.Group> search( 656 long companyId, long[] classNameIds, java.lang.String keywords, 657 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 658 int start, int end, 659 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc) 660 throws com.liferay.portal.kernel.exception.PortalException { 661 return _groupService.search(companyId, classNameIds, keywords, params, 662 start, end, obc); 663 } 664 665 @Override 666 public java.util.List<com.liferay.portal.model.Group> search( 667 long companyId, long[] classNameIds, java.lang.String name, 668 java.lang.String description, 669 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 670 boolean andOperator, int start, int end, 671 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc) 672 throws com.liferay.portal.kernel.exception.PortalException { 673 return _groupService.search(companyId, classNameIds, name, description, 674 params, andOperator, start, end, obc); 675 } 676 677 /** 678 * Returns an ordered range of all the site groups and organization groups 679 * that match the name and description, optionally including the user's 680 * inherited organization groups and user groups. System and staged groups 681 * are not included. 682 * 683 * <p> 684 * Useful when paginating results. Returns a maximum of <code>end - 685 * start</code> instances. <code>start</code> and <code>end</code> are not 686 * primary keys, they are indexes in the result set. Thus, <code>0</code> 687 * refers to the first result in the set. Setting both <code>start</code> 688 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 689 * result set. 690 * </p> 691 * 692 * @param companyId the primary key of the company 693 * @param name the group's name (optionally <code>null</code>) 694 * @param description the group's description (optionally 695 <code>null</code>) 696 * @param params the finder params (optionally <code>null</code>). To 697 include the user's inherited organizations and user groups in the 698 search, add entries having "usersGroups" and 699 "inherit" as keys mapped to the the user's ID. For more 700 information see {@link 701 com.liferay.portal.service.persistence.GroupFinder}. 702 * @param start the lower bound of the range of groups to return 703 * @param end the upper bound of the range of groups to return (not 704 inclusive) 705 * @return the matching groups ordered by name 706 * @throws PortalException if a portal exception occurred 707 */ 708 @Override 709 public java.util.List<com.liferay.portal.model.Group> search( 710 long companyId, java.lang.String name, java.lang.String description, 711 java.lang.String[] params, int start, int end) 712 throws com.liferay.portal.kernel.exception.PortalException { 713 return _groupService.search(companyId, name, description, params, 714 start, end); 715 } 716 717 /** 718 * Returns the number of groups and organization groups that match the name 719 * and description, optionally including the user's inherited organizations 720 * and user groups. System and staged groups are not included. 721 * 722 * @param companyId the primary key of the company 723 * @param name the group's name (optionally <code>null</code>) 724 * @param description the group's description (optionally 725 <code>null</code>) 726 * @param params the finder params (optionally <code>null</code>). To 727 include the user's inherited organizations and user groups in the 728 search, add entries having "usersGroups" and 729 "inherit" as keys mapped to the the user's ID. For more 730 information see {@link 731 com.liferay.portal.service.persistence.GroupFinder}. 732 * @return the number of matching groups 733 */ 734 @Override 735 public int searchCount(long companyId, java.lang.String name, 736 java.lang.String description, java.lang.String[] params) { 737 return _groupService.searchCount(companyId, name, description, params); 738 } 739 740 /** 741 * Sets the Spring bean ID for this bean. 742 * 743 * @param beanIdentifier the Spring bean ID for this bean 744 */ 745 @Override 746 public void setBeanIdentifier(java.lang.String beanIdentifier) { 747 _groupService.setBeanIdentifier(beanIdentifier); 748 } 749 750 /** 751 * Sets the groups associated with the role, removing and adding 752 * associations as necessary. 753 * 754 * @param roleId the primary key of the role 755 * @param groupIds the primary keys of the groups 756 * @throws PortalException if the user did not have permission to update 757 update the role 758 */ 759 @Override 760 public void setRoleGroups(long roleId, long[] groupIds) 761 throws com.liferay.portal.kernel.exception.PortalException { 762 _groupService.setRoleGroups(roleId, groupIds); 763 } 764 765 /** 766 * Removes the groups from the role. 767 * 768 * @param roleId the primary key of the role 769 * @param groupIds the primary keys of the groups 770 * @throws PortalException if the user did not have permission to update the 771 role 772 */ 773 @Override 774 public void unsetRoleGroups(long roleId, long[] groupIds) 775 throws com.liferay.portal.kernel.exception.PortalException { 776 _groupService.unsetRoleGroups(roleId, groupIds); 777 } 778 779 /** 780 * Updates the group's friendly URL. 781 * 782 * @param groupId the primary key of the group 783 * @param friendlyURL the group's new friendlyURL (optionally 784 <code>null</code>) 785 * @return the group 786 * @throws PortalException if the user did not have permission to update the 787 group, if a group with the primary key could not be found, or if 788 a valid friendly URL could not be created for the group 789 */ 790 @Override 791 public com.liferay.portal.model.Group updateFriendlyURL(long groupId, 792 java.lang.String friendlyURL) 793 throws com.liferay.portal.kernel.exception.PortalException { 794 return _groupService.updateFriendlyURL(groupId, friendlyURL); 795 } 796 797 /** 798 * Updates the group. 799 * 800 * @param groupId the primary key of the group 801 * @param parentGroupId the primary key of the parent group 802 * @param name the group's name 803 * @param description the group's new description (optionally 804 <code>null</code>) 805 * @param type the group's new type. For more information see {@link 806 GroupConstants}. 807 * @param manualMembership whether manual membership is allowed for the 808 group 809 * @param membershipRestriction the group's membership restriction. For 810 more information see {@link GroupConstants}. 811 * @param friendlyURL the group's new friendlyURL (optionally 812 <code>null</code>) 813 * @param active whether the group is active 814 * @param serviceContext the service context to be applied (optionally 815 <code>null</code>). Can set the asset category IDs and asset 816 tag names for the group. 817 * @return the group 818 * @throws PortalException if the user did not have permission to update 819 the group, if a group with the primary key could not be 820 found, if the friendly URL was invalid or could one not be 821 created 822 * @deprecated As of 7.0.0, replaced by {@link #updateGroup(long, long, Map, 823 Map, int, boolean, int, String, boolean, boolean, 824 ServiceContext)} 825 */ 826 @Deprecated 827 @Override 828 public com.liferay.portal.model.Group updateGroup(long groupId, 829 long parentGroupId, java.lang.String name, 830 java.lang.String description, int type, boolean manualMembership, 831 int membershipRestriction, java.lang.String friendlyURL, 832 boolean inheritContent, boolean active, 833 com.liferay.portal.service.ServiceContext serviceContext) 834 throws com.liferay.portal.kernel.exception.PortalException { 835 return _groupService.updateGroup(groupId, parentGroupId, name, 836 description, type, manualMembership, membershipRestriction, 837 friendlyURL, inheritContent, active, serviceContext); 838 } 839 840 @Override 841 public com.liferay.portal.model.Group updateGroup(long groupId, 842 long parentGroupId, 843 java.util.Map<java.util.Locale, java.lang.String> nameMap, 844 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 845 int type, boolean manualMembership, int membershipRestriction, 846 java.lang.String friendlyURL, boolean inheritContent, boolean active, 847 com.liferay.portal.service.ServiceContext serviceContext) 848 throws com.liferay.portal.kernel.exception.PortalException { 849 return _groupService.updateGroup(groupId, parentGroupId, nameMap, 850 descriptionMap, type, manualMembership, membershipRestriction, 851 friendlyURL, inheritContent, active, serviceContext); 852 } 853 854 /** 855 * Updates the group's type settings. 856 * 857 * @param groupId the primary key of the group 858 * @param typeSettings the group's new type settings (optionally 859 <code>null</code>) 860 * @return the group 861 * @throws PortalException if the user did not have permission to update the 862 group or if a group with the primary key could not be found 863 */ 864 @Override 865 public com.liferay.portal.model.Group updateGroup(long groupId, 866 java.lang.String typeSettings) 867 throws com.liferay.portal.kernel.exception.PortalException { 868 return _groupService.updateGroup(groupId, typeSettings); 869 } 870 871 @Override 872 public void updateStagedPortlets(long groupId, 873 java.util.Map<java.lang.String, java.lang.String> stagedPortletIds) 874 throws com.liferay.portal.kernel.exception.PortalException { 875 _groupService.updateStagedPortlets(groupId, stagedPortletIds); 876 } 877 878 /** 879 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 880 */ 881 @Deprecated 882 public GroupService getWrappedGroupService() { 883 return _groupService; 884 } 885 886 /** 887 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 888 */ 889 @Deprecated 890 public void setWrappedGroupService(GroupService groupService) { 891 _groupService = groupService; 892 } 893 894 @Override 895 public GroupService getWrappedService() { 896 return _groupService; 897 } 898 899 @Override 900 public void setWrappedService(GroupService groupService) { 901 _groupService = groupService; 902 } 903 904 private GroupService _groupService; 905 }