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 386 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 387 * result set. 388 * </p> 389 * 390 * @param userId the primary key of the user 391 * @param start the lower bound of the range of groups to consider 392 * @param end the upper bound of the range of groups to consider (not 393 inclusive) 394 * @return the range of groups associated with the user's organizations 395 * @throws PortalException if a user with the primary key could not be found 396 or if another portal exception occurred 397 */ 398 @Override 399 public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups( 400 long userId, int start, int end) 401 throws com.liferay.portal.kernel.exception.PortalException { 402 return _groupService.getUserOrganizationsGroups(userId, start, end); 403 } 404 405 /** 406 * Returns the guest or current user's groups "sites" associated 407 * with the group entity class names, including the Control Panel group if 408 * the user is permitted to view the Control Panel. 409 * 410 * <ul> 411 * <li> 412 * Class name "User" includes the user's layout set 413 * group. 414 * </li> 415 * <li> 416 * Class name "Organization" includes the user's 417 * immediate organization groups and inherited organization groups. 418 * </li> 419 * <li> 420 * Class name "Group" includes the user's immediate 421 * organization groups and site groups. 422 * </li> 423 * <li> 424 * A <code>classNames</code> 425 * value of <code>null</code> includes the user's layout set group, 426 * organization groups, inherited organization groups, and site groups. 427 * </li> 428 * </ul> 429 * 430 * @param classNames the group entity class names (optionally 431 <code>null</code>). For more information see {@link 432 #getUserSitesGroups(String[], int)}. 433 * @param max the maximum number of groups to return 434 * @return the user's groups "sites" 435 * @throws PortalException if a portal exception occurred 436 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(String[], 437 int)} 438 */ 439 @Deprecated 440 @Override 441 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 442 java.lang.String[] classNames, int max) 443 throws com.liferay.portal.kernel.exception.PortalException { 444 return _groupService.getUserPlaces(classNames, max); 445 } 446 447 /** 448 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(long, 449 String[], boolean, int)} 450 */ 451 @Deprecated 452 @Override 453 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 454 long userId, java.lang.String[] classNames, 455 boolean includeControlPanel, int max) 456 throws com.liferay.portal.kernel.exception.PortalException { 457 return _groupService.getUserPlaces(userId, classNames, 458 includeControlPanel, max); 459 } 460 461 /** 462 * Returns the user's groups "sites" associated with the group 463 * entity class names, including the Control Panel group if the user is 464 * permitted to view the Control Panel. 465 * 466 * <ul> 467 * <li> 468 * Class name "User" includes the user's layout set 469 * group. 470 * </li> 471 * <li> 472 * Class name "Organization" includes the user's 473 * immediate organization groups and inherited organization groups. 474 * </li> 475 * <li> 476 * Class name "Group" includes the user's immediate 477 * organization groups and site groups. 478 * </li> 479 * <li> 480 * A <code>classNames</code> 481 * value of <code>null</code> includes the user's layout set group, 482 * organization groups, inherited organization groups, and site groups. 483 * </li> 484 * </ul> 485 * 486 * @param userId the primary key of the user 487 * @param classNames the group entity class names (optionally 488 <code>null</code>). For more information see {@link 489 #getUserSitesGroups(long, String[], int)}. 490 * @param max the maximum number of groups to return 491 * @return the user's groups "sites" 492 * @throws PortalException if a portal exception occurred 493 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups(long, 494 String[], int)} 495 */ 496 @Deprecated 497 @Override 498 public java.util.List<com.liferay.portal.model.Group> getUserPlaces( 499 long userId, java.lang.String[] classNames, int max) 500 throws com.liferay.portal.kernel.exception.PortalException { 501 return _groupService.getUserPlaces(userId, classNames, max); 502 } 503 504 /** 505 * Returns the number of the guest or current user's groups 506 * "sites" associated with the group entity class names, including 507 * the Control Panel group if the user is permitted to view the Control 508 * Panel. 509 * 510 * @return the number of user's groups "sites" 511 * @throws PortalException if a portal exception occurred 512 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroupsCount()} 513 */ 514 @Deprecated 515 @Override 516 public int getUserPlacesCount() 517 throws com.liferay.portal.kernel.exception.PortalException { 518 return _groupService.getUserPlacesCount(); 519 } 520 521 /** 522 * Returns the guest or current user's layout set group, organization 523 * groups, inherited organization groups, and site groups. 524 * 525 * @return the user's layout set group, organization groups, and 526 inherited organization groups, and site groups 527 * @throws PortalException if a portal exception occurred 528 * @deprecated As of 6.2.0, replaced by {@link #getUserSitesGroups} 529 */ 530 @Deprecated 531 @Override 532 public java.util.List<com.liferay.portal.model.Group> getUserSites() 533 throws com.liferay.portal.kernel.exception.PortalException { 534 return _groupService.getUserSites(); 535 } 536 537 @Override 538 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups() 539 throws com.liferay.portal.kernel.exception.PortalException { 540 return _groupService.getUserSitesGroups(); 541 } 542 543 /** 544 * Returns the guest or current user's groups "sites" associated 545 * with the group entity class names, including the Control Panel group if 546 * the user is permitted to view the Control Panel. 547 * 548 * <ul> 549 * <li> 550 * Class name "User" includes the user's layout set 551 * group. 552 * </li> 553 * <li> 554 * Class name "Organization" includes the user's 555 * immediate organization groups and inherited organization groups. 556 * </li> 557 * <li> 558 * Class name "Group" includes the user's immediate 559 * organization groups and site groups. 560 * </li> 561 * <li> 562 * A <code>classNames</code> 563 * value of <code>null</code> includes the user's layout set group, 564 * organization groups, inherited organization groups, and site groups. 565 * </li> 566 * </ul> 567 * 568 * @param classNames the group entity class names (optionally 569 <code>null</code>). For more information see {@link 570 #getUserSitesGroups(long, String[], boolean, int)}. 571 * @param max the maximum number of groups to return 572 * @return the user's groups "sites" 573 * @throws PortalException if a portal exception occurred 574 */ 575 @Override 576 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups( 577 java.lang.String[] classNames, int max) 578 throws com.liferay.portal.kernel.exception.PortalException { 579 return _groupService.getUserSitesGroups(classNames, max); 580 } 581 582 @Override 583 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups( 584 long userId, java.lang.String[] classNames, 585 boolean includeControlPanel, int max) 586 throws com.liferay.portal.kernel.exception.PortalException { 587 return _groupService.getUserSitesGroups(userId, classNames, 588 includeControlPanel, max); 589 } 590 591 /** 592 * Returns the user's groups "sites" associated with the group 593 * entity class names, including the Control Panel group if the user is 594 * permitted to view the Control Panel. 595 * 596 * <ul> 597 * <li> 598 * Class name "User" includes the user's layout set 599 * group. 600 * </li> 601 * <li> 602 * Class name "Organization" includes the user's 603 * immediate organization groups and inherited organization groups. 604 * </li> 605 * <li> 606 * Class name "Group" includes the user's immediate 607 * organization groups and site groups. 608 * </li> 609 * <li> 610 * A <code>classNames</code> 611 * value of <code>null</code> includes the user's layout set group, 612 * organization groups, inherited organization groups, and site groups. 613 * </li> 614 * </ul> 615 * 616 * @param userId the primary key of the user 617 * @param classNames the group entity class names (optionally 618 <code>null</code>). For more information see {@link 619 #getUserSitesGroups(long, String[], boolean, int)}. 620 * @param max the maximum number of groups to return 621 * @return the user's groups "sites" 622 * @throws PortalException if a portal exception occurred 623 */ 624 @Override 625 public java.util.List<com.liferay.portal.model.Group> getUserSitesGroups( 626 long userId, java.lang.String[] classNames, int max) 627 throws com.liferay.portal.kernel.exception.PortalException { 628 return _groupService.getUserSitesGroups(userId, classNames, max); 629 } 630 631 /** 632 * Returns the number of the guest or current user's groups 633 * "sites" associated with the group entity class names, including 634 * the Control Panel group if the user is permitted to view the Control 635 * Panel. 636 * 637 * @return the number of user's groups "sites" 638 * @throws PortalException if a portal exception occurred 639 */ 640 @Override 641 public int getUserSitesGroupsCount() 642 throws com.liferay.portal.kernel.exception.PortalException { 643 return _groupService.getUserSitesGroupsCount(); 644 } 645 646 /** 647 * Returns <code>true</code> if the user is associated with the group, 648 * including the user's inherited organizations and user groups. System and 649 * staged groups are not included. 650 * 651 * @param userId the primary key of the user 652 * @param groupId the primary key of the group 653 * @return <code>true</code> if the user is associated with the group; 654 <code>false</code> otherwise 655 * @throws PortalException if the current user did not have permission to 656 view the user or group members 657 */ 658 @Override 659 public boolean hasUserGroup(long userId, long groupId) 660 throws com.liferay.portal.kernel.exception.PortalException { 661 return _groupService.hasUserGroup(userId, groupId); 662 } 663 664 @Override 665 public java.util.List<com.liferay.portal.model.Group> search( 666 long companyId, long[] classNameIds, java.lang.String keywords, 667 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 668 int start, int end, 669 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc) 670 throws com.liferay.portal.kernel.exception.PortalException { 671 return _groupService.search(companyId, classNameIds, keywords, params, 672 start, end, obc); 673 } 674 675 @Override 676 public java.util.List<com.liferay.portal.model.Group> search( 677 long companyId, long[] classNameIds, java.lang.String name, 678 java.lang.String description, 679 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 680 boolean andOperator, int start, int end, 681 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Group> obc) 682 throws com.liferay.portal.kernel.exception.PortalException { 683 return _groupService.search(companyId, classNameIds, name, description, 684 params, andOperator, start, end, obc); 685 } 686 687 /** 688 * Returns an ordered range of all the site groups and organization groups 689 * that match the name and description, optionally including the user's 690 * inherited organization groups and user groups. System and staged groups 691 * are not included. 692 * 693 * <p> 694 * Useful when paginating results. Returns a maximum of <code>end - 695 * start</code> instances. <code>start</code> and <code>end</code> are not 696 * primary keys, they are indexes in the result set. Thus, <code>0</code> 697 * refers to the first result in the set. Setting both <code>start</code> 698 * and <code>end</code> to {@link 699 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 700 * result set. 701 * </p> 702 * 703 * @param companyId the primary key of the company 704 * @param name the group's name (optionally <code>null</code>) 705 * @param description the group's description (optionally 706 <code>null</code>) 707 * @param params the finder params (optionally <code>null</code>). To 708 include the user's inherited organizations and user groups in the 709 search, add entries having "usersGroups" and 710 "inherit" as keys mapped to the the user's ID. For more 711 information see {@link 712 com.liferay.portal.service.persistence.GroupFinder}. 713 * @param start the lower bound of the range of groups to return 714 * @param end the upper bound of the range of groups to return (not 715 inclusive) 716 * @return the matching groups ordered by name 717 * @throws PortalException if a portal exception occurred 718 */ 719 @Override 720 public java.util.List<com.liferay.portal.model.Group> search( 721 long companyId, java.lang.String name, java.lang.String description, 722 java.lang.String[] params, int start, int end) 723 throws com.liferay.portal.kernel.exception.PortalException { 724 return _groupService.search(companyId, name, description, params, 725 start, end); 726 } 727 728 /** 729 * Returns the number of groups and organization groups that match the name 730 * and description, optionally including the user's inherited organizations 731 * and user groups. System and staged groups are not included. 732 * 733 * @param companyId the primary key of the company 734 * @param name the group's name (optionally <code>null</code>) 735 * @param description the group's description (optionally 736 <code>null</code>) 737 * @param params the finder params (optionally <code>null</code>). To 738 include the user's inherited organizations and user groups in the 739 search, add entries having "usersGroups" and 740 "inherit" as keys mapped to the the user's ID. For more 741 information see {@link 742 com.liferay.portal.service.persistence.GroupFinder}. 743 * @return the number of matching groups 744 */ 745 @Override 746 public int searchCount(long companyId, java.lang.String name, 747 java.lang.String description, java.lang.String[] params) { 748 return _groupService.searchCount(companyId, name, description, params); 749 } 750 751 /** 752 * Sets the Spring bean ID for this bean. 753 * 754 * @param beanIdentifier the Spring bean ID for this bean 755 */ 756 @Override 757 public void setBeanIdentifier(java.lang.String beanIdentifier) { 758 _groupService.setBeanIdentifier(beanIdentifier); 759 } 760 761 /** 762 * Sets the groups associated with the role, removing and adding 763 * associations as necessary. 764 * 765 * @param roleId the primary key of the role 766 * @param groupIds the primary keys of the groups 767 * @throws PortalException if the user did not have permission to update 768 update the role 769 */ 770 @Override 771 public void setRoleGroups(long roleId, long[] groupIds) 772 throws com.liferay.portal.kernel.exception.PortalException { 773 _groupService.setRoleGroups(roleId, groupIds); 774 } 775 776 /** 777 * Removes the groups from the role. 778 * 779 * @param roleId the primary key of the role 780 * @param groupIds the primary keys of the groups 781 * @throws PortalException if the user did not have permission to update the 782 role 783 */ 784 @Override 785 public void unsetRoleGroups(long roleId, long[] groupIds) 786 throws com.liferay.portal.kernel.exception.PortalException { 787 _groupService.unsetRoleGroups(roleId, groupIds); 788 } 789 790 /** 791 * Updates the group's friendly URL. 792 * 793 * @param groupId the primary key of the group 794 * @param friendlyURL the group's new friendlyURL (optionally 795 <code>null</code>) 796 * @return the group 797 * @throws PortalException if the user did not have permission to update the 798 group, if a group with the primary key could not be found, or if 799 a valid friendly URL could not be created for the group 800 */ 801 @Override 802 public com.liferay.portal.model.Group updateFriendlyURL(long groupId, 803 java.lang.String friendlyURL) 804 throws com.liferay.portal.kernel.exception.PortalException { 805 return _groupService.updateFriendlyURL(groupId, friendlyURL); 806 } 807 808 /** 809 * Updates the group. 810 * 811 * @param groupId the primary key of the group 812 * @param parentGroupId the primary key of the parent group 813 * @param name the group's name 814 * @param description the group's new description (optionally 815 <code>null</code>) 816 * @param type the group's new type. For more information see {@link 817 GroupConstants}. 818 * @param manualMembership whether manual membership is allowed for the 819 group 820 * @param membershipRestriction the group's membership restriction. For 821 more information see {@link GroupConstants}. 822 * @param friendlyURL the group's new friendlyURL (optionally 823 <code>null</code>) 824 * @param active whether the group is active 825 * @param serviceContext the service context to be applied (optionally 826 <code>null</code>). Can set the asset category IDs and asset 827 tag names for the group. 828 * @return the group 829 * @throws PortalException if the user did not have permission to update 830 the group, if a group with the primary key could not be 831 found, if the friendly URL was invalid or could one not be 832 created 833 * @deprecated As of 7.0.0, replaced by {@link #updateGroup(long, long, Map, 834 Map, int, boolean, int, String, boolean, boolean, 835 ServiceContext)} 836 */ 837 @Deprecated 838 @Override 839 public com.liferay.portal.model.Group updateGroup(long groupId, 840 long parentGroupId, java.lang.String name, 841 java.lang.String description, int type, boolean manualMembership, 842 int membershipRestriction, java.lang.String friendlyURL, 843 boolean inheritContent, boolean active, 844 com.liferay.portal.service.ServiceContext serviceContext) 845 throws com.liferay.portal.kernel.exception.PortalException { 846 return _groupService.updateGroup(groupId, parentGroupId, name, 847 description, type, manualMembership, membershipRestriction, 848 friendlyURL, inheritContent, active, serviceContext); 849 } 850 851 @Override 852 public com.liferay.portal.model.Group updateGroup(long groupId, 853 long parentGroupId, 854 java.util.Map<java.util.Locale, java.lang.String> nameMap, 855 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 856 int type, boolean manualMembership, int membershipRestriction, 857 java.lang.String friendlyURL, boolean inheritContent, boolean active, 858 com.liferay.portal.service.ServiceContext serviceContext) 859 throws com.liferay.portal.kernel.exception.PortalException { 860 return _groupService.updateGroup(groupId, parentGroupId, nameMap, 861 descriptionMap, type, manualMembership, membershipRestriction, 862 friendlyURL, inheritContent, active, serviceContext); 863 } 864 865 /** 866 * Updates the group's type settings. 867 * 868 * @param groupId the primary key of the group 869 * @param typeSettings the group's new type settings (optionally 870 <code>null</code>) 871 * @return the group 872 * @throws PortalException if the user did not have permission to update the 873 group or if a group with the primary key could not be found 874 */ 875 @Override 876 public com.liferay.portal.model.Group updateGroup(long groupId, 877 java.lang.String typeSettings) 878 throws com.liferay.portal.kernel.exception.PortalException { 879 return _groupService.updateGroup(groupId, typeSettings); 880 } 881 882 @Override 883 public void updateStagedPortlets(long groupId, 884 java.util.Map<java.lang.String, java.lang.String> stagedPortletIds) 885 throws com.liferay.portal.kernel.exception.PortalException { 886 _groupService.updateStagedPortlets(groupId, stagedPortletIds); 887 } 888 889 /** 890 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 891 */ 892 @Deprecated 893 public GroupService getWrappedGroupService() { 894 return _groupService; 895 } 896 897 /** 898 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 899 */ 900 @Deprecated 901 public void setWrappedGroupService(GroupService groupService) { 902 _groupService = groupService; 903 } 904 905 @Override 906 public GroupService getWrappedService() { 907 return _groupService; 908 } 909 910 @Override 911 public void setWrappedService(GroupService groupService) { 912 _groupService = groupService; 913 } 914 915 private GroupService _groupService; 916 }