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.kernel.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 * Returns <code>true</code> if the user is associated with the group, 035 * including the user's inherited organizations and user groups. System and 036 * staged groups are not included. 037 * 038 * @param userId the primary key of the user 039 * @param groupId the primary key of the group 040 * @return <code>true</code> if the user is associated with the group; 041 <code>false</code> otherwise 042 * @throws PortalException if a portal exception occurred 043 */ 044 @Override 045 public boolean hasUserGroup(long userId, long groupId) 046 throws com.liferay.portal.kernel.exception.PortalException { 047 return _groupService.hasUserGroup(userId, groupId); 048 } 049 050 /** 051 * Adds a group. 052 * 053 * @param parentGroupId the primary key of the parent group 054 * @param liveGroupId the primary key of the live group 055 * @param name the entity's name 056 * @param description the group's description (optionally 057 <code>null</code>) 058 * @param type the group's type. For more information see {@link 059 GroupConstants}. 060 * @param manualMembership whether manual membership is allowed for the 061 group 062 * @param membershipRestriction the group's membership restriction. For 063 more information see {@link GroupConstants}. 064 * @param friendlyURL the group's friendlyURL (optionally 065 <code>null</code>) 066 * @param site whether the group is to be associated with a main site 067 * @param active whether the group is active 068 * @param serviceContext the service context to be applied (optionally 069 <code>null</code>). Can set the asset category IDs and asset 070 tag names for the group, and can set whether the group is for 071 staging 072 * @return the group 073 * @throws PortalException if a portal exception occurred 074 * @deprecated As of 7.0.0, replaced by {@link #addGroup(long, long, Map, 075 Map, int, boolean, int, String, boolean, boolean, 076 ServiceContext)} 077 */ 078 @Deprecated 079 @Override 080 public com.liferay.portal.kernel.model.Group addGroup(long parentGroupId, 081 long liveGroupId, java.lang.String name, java.lang.String description, 082 int type, boolean manualMembership, int membershipRestriction, 083 java.lang.String friendlyURL, boolean site, boolean active, 084 ServiceContext serviceContext) 085 throws com.liferay.portal.kernel.exception.PortalException { 086 return _groupService.addGroup(parentGroupId, liveGroupId, name, 087 description, type, manualMembership, membershipRestriction, 088 friendlyURL, site, active, serviceContext); 089 } 090 091 @Override 092 public com.liferay.portal.kernel.model.Group addGroup(long parentGroupId, 093 long liveGroupId, 094 java.util.Map<java.util.Locale, java.lang.String> nameMap, 095 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 096 int type, boolean manualMembership, int membershipRestriction, 097 java.lang.String friendlyURL, boolean site, boolean active, 098 ServiceContext serviceContext) 099 throws com.liferay.portal.kernel.exception.PortalException { 100 return _groupService.addGroup(parentGroupId, liveGroupId, nameMap, 101 descriptionMap, type, manualMembership, membershipRestriction, 102 friendlyURL, site, active, serviceContext); 103 } 104 105 @Override 106 public com.liferay.portal.kernel.model.Group addGroup(long parentGroupId, 107 long liveGroupId, 108 java.util.Map<java.util.Locale, java.lang.String> nameMap, 109 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 110 int type, boolean manualMembership, int membershipRestriction, 111 java.lang.String friendlyURL, boolean site, boolean inheritContent, 112 boolean active, ServiceContext serviceContext) 113 throws com.liferay.portal.kernel.exception.PortalException { 114 return _groupService.addGroup(parentGroupId, liveGroupId, nameMap, 115 descriptionMap, type, manualMembership, membershipRestriction, 116 friendlyURL, site, inheritContent, active, serviceContext); 117 } 118 119 /** 120 * Returns the company group. 121 * 122 * @param companyId the primary key of the company 123 * @return the group associated with the company 124 * @throws PortalException if a portal exception occurred 125 */ 126 @Override 127 public com.liferay.portal.kernel.model.Group getCompanyGroup(long companyId) 128 throws com.liferay.portal.kernel.exception.PortalException { 129 return _groupService.getCompanyGroup(companyId); 130 } 131 132 /** 133 * Returns the group with the name. 134 * 135 * @param companyId the primary key of the company 136 * @param groupKey the group key 137 * @return the group with the group key 138 * @throws PortalException if a portal exception occurred 139 */ 140 @Override 141 public com.liferay.portal.kernel.model.Group getGroup(long companyId, 142 java.lang.String groupKey) 143 throws com.liferay.portal.kernel.exception.PortalException { 144 return _groupService.getGroup(companyId, groupKey); 145 } 146 147 /** 148 * Returns the group with the primary key. 149 * 150 * @param groupId the primary key of the group 151 * @return the group with the primary key 152 * @throws PortalException if a portal exception occurred 153 */ 154 @Override 155 public com.liferay.portal.kernel.model.Group getGroup(long groupId) 156 throws com.liferay.portal.kernel.exception.PortalException { 157 return _groupService.getGroup(groupId); 158 } 159 160 /** 161 * Returns the group directly associated with the user. 162 * 163 * @param companyId the primary key of the company 164 * @param userId the primary key of the user 165 * @return the group directly associated with the user 166 * @throws PortalException if a portal exception occurred 167 */ 168 @Override 169 public com.liferay.portal.kernel.model.Group getUserGroup(long companyId, 170 long userId) throws com.liferay.portal.kernel.exception.PortalException { 171 return _groupService.getUserGroup(companyId, userId); 172 } 173 174 /** 175 * Updates the group's friendly URL. 176 * 177 * @param groupId the primary key of the group 178 * @param friendlyURL the group's new friendlyURL (optionally 179 <code>null</code>) 180 * @return the group 181 * @throws PortalException if a portal exception occurred 182 */ 183 @Override 184 public com.liferay.portal.kernel.model.Group updateFriendlyURL( 185 long groupId, java.lang.String friendlyURL) 186 throws com.liferay.portal.kernel.exception.PortalException { 187 return _groupService.updateFriendlyURL(groupId, friendlyURL); 188 } 189 190 /** 191 * Updates the group's type settings. 192 * 193 * @param groupId the primary key of the group 194 * @param typeSettings the group's new type settings (optionally 195 <code>null</code>) 196 * @return the group 197 * @throws PortalException if a portal exception occurred 198 */ 199 @Override 200 public com.liferay.portal.kernel.model.Group updateGroup(long groupId, 201 java.lang.String typeSettings) 202 throws com.liferay.portal.kernel.exception.PortalException { 203 return _groupService.updateGroup(groupId, typeSettings); 204 } 205 206 /** 207 * Updates the group. 208 * 209 * @param groupId the primary key of the group 210 * @param parentGroupId the primary key of the parent group 211 * @param name the group's name 212 * @param description the group's new description (optionally 213 <code>null</code>) 214 * @param type the group's new type. For more information see {@link 215 GroupConstants}. 216 * @param manualMembership whether manual membership is allowed for the 217 group 218 * @param membershipRestriction the group's membership restriction. For 219 more information see {@link GroupConstants}. 220 * @param friendlyURL the group's new friendlyURL (optionally 221 <code>null</code>) 222 * @param inheritContent whether to inherit content from the parent 223 group 224 * @param active whether the group is active 225 * @param serviceContext the service context to be applied (optionally 226 <code>null</code>). Can set the asset category IDs and asset 227 tag names for the group. 228 * @return the group 229 * @throws PortalException if a portal exception occurred 230 * @deprecated As of 7.0.0, replaced by {@link #updateGroup(long, long, Map, 231 Map, int, boolean, int, String, boolean, boolean, 232 ServiceContext)} 233 */ 234 @Deprecated 235 @Override 236 public com.liferay.portal.kernel.model.Group updateGroup(long groupId, 237 long parentGroupId, java.lang.String name, 238 java.lang.String description, int type, boolean manualMembership, 239 int membershipRestriction, java.lang.String friendlyURL, 240 boolean inheritContent, boolean active, ServiceContext serviceContext) 241 throws com.liferay.portal.kernel.exception.PortalException { 242 return _groupService.updateGroup(groupId, parentGroupId, name, 243 description, type, manualMembership, membershipRestriction, 244 friendlyURL, inheritContent, active, serviceContext); 245 } 246 247 @Override 248 public com.liferay.portal.kernel.model.Group updateGroup(long groupId, 249 long parentGroupId, 250 java.util.Map<java.util.Locale, java.lang.String> nameMap, 251 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 252 int type, boolean manualMembership, int membershipRestriction, 253 java.lang.String friendlyURL, boolean inheritContent, boolean active, 254 ServiceContext serviceContext) 255 throws com.liferay.portal.kernel.exception.PortalException { 256 return _groupService.updateGroup(groupId, parentGroupId, nameMap, 257 descriptionMap, type, manualMembership, membershipRestriction, 258 friendlyURL, inheritContent, active, serviceContext); 259 } 260 261 /** 262 * Returns the number of the guest or current user's groups 263 * "sites" associated with the group entity class names, including 264 * the Control Panel group if the user is permitted to view the Control 265 * Panel. 266 * 267 * @return the number of user's groups "sites" 268 * @throws PortalException if a portal exception occurred 269 */ 270 @Override 271 public int getUserSitesGroupsCount() 272 throws com.liferay.portal.kernel.exception.PortalException { 273 return _groupService.getUserSitesGroupsCount(); 274 } 275 276 /** 277 * Returns the number of groups and organization groups that match the name 278 * and description, optionally including the user's inherited organizations 279 * and user groups. System and staged groups are not included. 280 * 281 * @param companyId the primary key of the company 282 * @param name the group's name (optionally <code>null</code>) 283 * @param description the group's description (optionally 284 <code>null</code>) 285 * @param params the finder params (optionally <code>null</code>). To 286 include the user's inherited organizations and user groups in the 287 search, add entries having "usersGroups" and 288 "inherit" as keys mapped to the the user's ID. For more 289 information see {@link 290 com.liferay.portal.kernel.service.persistence.GroupFinder}. 291 * @return the number of matching groups 292 */ 293 @Override 294 public int searchCount(long companyId, java.lang.String name, 295 java.lang.String description, java.lang.String[] params) { 296 return _groupService.searchCount(companyId, name, description, params); 297 } 298 299 /** 300 * Returns the group's display URL. 301 * 302 * @param groupId the primary key of the group 303 * @param privateLayout whether the layout set is private to the group 304 * @param secureConnection whether the generated URL uses a secure 305 connection 306 * @return the group's display URL 307 * @throws PortalException if a group with the primary key could not be 308 found or if a portal exception occurred 309 */ 310 @Override 311 public java.lang.String getGroupDisplayURL(long groupId, 312 boolean privateLayout, boolean secureConnection) 313 throws com.liferay.portal.kernel.exception.PortalException { 314 return _groupService.getGroupDisplayURL(groupId, privateLayout, 315 secureConnection); 316 } 317 318 /** 319 * Returns the OSGi service identifier. 320 * 321 * @return the OSGi service identifier 322 */ 323 @Override 324 public java.lang.String getOSGiServiceIdentifier() { 325 return _groupService.getOSGiServiceIdentifier(); 326 } 327 328 /** 329 * Returns all the groups that are direct children of the parent group. 330 * 331 * @param companyId the primary key of the company 332 * @param parentGroupId the primary key of the parent group 333 * @param site whether the group is to be associated with a main site 334 * @return the matching groups, or <code>null</code> if no matches were 335 found 336 * @throws PortalException if a portal exception occurred 337 */ 338 @Override 339 public java.util.List<com.liferay.portal.kernel.model.Group> getGroups( 340 long companyId, long parentGroupId, boolean site) 341 throws com.liferay.portal.kernel.exception.PortalException { 342 return _groupService.getGroups(companyId, parentGroupId, site); 343 } 344 345 /** 346 * Returns a range of all the site groups for which the user has control 347 * panel access. 348 * 349 * @param portlets the portlets to manage 350 * @param max the upper bound of the range of groups to consider (not 351 inclusive) 352 * @return the range of site groups for which the user has Control Panel 353 access 354 * @throws PortalException if a portal exception occurred 355 */ 356 @Override 357 public java.util.List<com.liferay.portal.kernel.model.Group> getManageableSiteGroups( 358 java.util.Collection<com.liferay.portal.kernel.model.Portlet> portlets, 359 int max) throws com.liferay.portal.kernel.exception.PortalException { 360 return _groupService.getManageableSiteGroups(portlets, max); 361 } 362 363 /** 364 * Returns the groups associated with the organizations. 365 * 366 * @param organizations the organizations 367 * @return the groups associated with the organizations 368 * @throws PortalException if a portal exception occurred 369 */ 370 @Override 371 public java.util.List<com.liferay.portal.kernel.model.Group> getOrganizationsGroups( 372 java.util.List<com.liferay.portal.kernel.model.Organization> organizations) 373 throws com.liferay.portal.kernel.exception.PortalException { 374 return _groupService.getOrganizationsGroups(organizations); 375 } 376 377 /** 378 * Returns the groups associated with the user groups. 379 * 380 * @param userGroups the user groups 381 * @return the groups associated with the user groups 382 * @throws PortalException if a portal exception occurred 383 */ 384 @Override 385 public java.util.List<com.liferay.portal.kernel.model.Group> getUserGroupsGroups( 386 java.util.List<com.liferay.portal.kernel.model.UserGroup> userGroups) 387 throws com.liferay.portal.kernel.exception.PortalException { 388 return _groupService.getUserGroupsGroups(userGroups); 389 } 390 391 /** 392 * Returns the range of all groups associated with the user's organization 393 * groups, including the ancestors of the organization groups, unless portal 394 * property <code>organizations.membership.strict</code> is set to 395 * <code>true</code>. 396 * 397 * <p> 398 * Useful when paginating results. Returns a maximum of <code>end - 399 * start</code> instances. <code>start</code> and <code>end</code> are not 400 * primary keys, they are indexes in the result set. Thus, <code>0</code> 401 * refers to the first result in the set. Setting both <code>start</code> 402 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 403 * result set. 404 * </p> 405 * 406 * @param userId the primary key of the user 407 * @param start the lower bound of the range of groups to consider 408 * @param end the upper bound of the range of groups to consider (not 409 inclusive) 410 * @return the range of groups associated with the user's organizations 411 * @throws PortalException if a portal exception occurred 412 */ 413 @Override 414 public java.util.List<com.liferay.portal.kernel.model.Group> getUserOrganizationsGroups( 415 long userId, int start, int end) 416 throws com.liferay.portal.kernel.exception.PortalException { 417 return _groupService.getUserOrganizationsGroups(userId, start, end); 418 } 419 420 @Override 421 public java.util.List<com.liferay.portal.kernel.model.Group> getUserSitesGroups() 422 throws com.liferay.portal.kernel.exception.PortalException { 423 return _groupService.getUserSitesGroups(); 424 } 425 426 /** 427 * Returns the guest or current user's groups "sites" associated 428 * with the group entity class names, including the Control Panel group if 429 * the user is permitted to view the Control Panel. 430 * 431 * <ul> 432 * <li> 433 * Class name "User" includes the user's layout set 434 * group. 435 * </li> 436 * <li> 437 * Class name "Organization" includes the user's 438 * immediate organization groups and inherited organization groups. 439 * </li> 440 * <li> 441 * Class name "Group" includes the user's immediate 442 * organization groups and site groups. 443 * </li> 444 * <li> 445 * A <code>classNames</code> 446 * value of <code>null</code> includes the user's layout set group, 447 * organization groups, inherited organization groups, and site groups. 448 * </li> 449 * </ul> 450 * 451 * @param classNames the group entity class names (optionally 452 <code>null</code>). For more information see {@link 453 #getUserSitesGroups(long, String[], int)}. 454 * @param max the maximum number of groups to return 455 * @return the user's groups "sites" 456 * @throws PortalException if a portal exception occurred 457 */ 458 @Override 459 public java.util.List<com.liferay.portal.kernel.model.Group> getUserSitesGroups( 460 java.lang.String[] classNames, int max) 461 throws com.liferay.portal.kernel.exception.PortalException { 462 return _groupService.getUserSitesGroups(classNames, max); 463 } 464 465 /** 466 * Returns the user's groups "sites" associated with the group 467 * entity class names, including the Control Panel group if the user is 468 * permitted to view the Control Panel. 469 * 470 * <ul> 471 * <li> 472 * Class name "User" includes the user's layout set 473 * group. 474 * </li> 475 * <li> 476 * Class name "Organization" includes the user's 477 * immediate organization groups and inherited organization groups. 478 * </li> 479 * <li> 480 * Class name "Group" includes the user's immediate 481 * organization groups and site groups. 482 * </li> 483 * <li> 484 * A <code>classNames</code> 485 * value of <code>null</code> includes the user's layout set group, 486 * organization groups, inherited organization groups, and site groups. 487 * </li> 488 * </ul> 489 * 490 * @param userId the primary key of the user 491 * @param classNames the group entity class names (optionally 492 <code>null</code>). For more information see {@link 493 #getUserSitesGroups(long, String[], int)}. 494 * @param max the maximum number of groups to return 495 * @return the user's groups "sites" 496 * @throws PortalException if a portal exception occurred 497 */ 498 @Override 499 public java.util.List<com.liferay.portal.kernel.model.Group> getUserSitesGroups( 500 long userId, java.lang.String[] classNames, int max) 501 throws com.liferay.portal.kernel.exception.PortalException { 502 return _groupService.getUserSitesGroups(userId, classNames, max); 503 } 504 505 /** 506 * Returns an ordered range of all the site groups and organization groups 507 * that match the name and description, optionally including the user's 508 * inherited organization groups and user groups. System and staged groups 509 * are not included. 510 * 511 * <p> 512 * Useful when paginating results. Returns a maximum of <code>end - 513 * start</code> instances. <code>start</code> and <code>end</code> are not 514 * primary keys, they are indexes in the result set. Thus, <code>0</code> 515 * refers to the first result in the set. Setting both <code>start</code> 516 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 517 * result set. 518 * </p> 519 * 520 * @param companyId the primary key of the company 521 * @param name the group's name (optionally <code>null</code>) 522 * @param description the group's description (optionally 523 <code>null</code>) 524 * @param params the finder params (optionally <code>null</code>). To 525 include the user's inherited organizations and user groups in the 526 search, add entries having "usersGroups" and 527 "inherit" as keys mapped to the the user's ID. For more 528 information see {@link 529 com.liferay.portal.kernel.service.persistence.GroupFinder}. 530 * @param start the lower bound of the range of groups to return 531 * @param end the upper bound of the range of groups to return (not 532 inclusive) 533 * @return the matching groups ordered by name 534 * @throws PortalException if a portal exception occurred 535 */ 536 @Override 537 public java.util.List<com.liferay.portal.kernel.model.Group> search( 538 long companyId, java.lang.String name, java.lang.String description, 539 java.lang.String[] params, int start, int end) 540 throws com.liferay.portal.kernel.exception.PortalException { 541 return _groupService.search(companyId, name, description, params, 542 start, end); 543 } 544 545 @Override 546 public java.util.List<com.liferay.portal.kernel.model.Group> search( 547 long companyId, long[] classNameIds, java.lang.String keywords, 548 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 549 int start, int end, 550 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc) 551 throws com.liferay.portal.kernel.exception.PortalException { 552 return _groupService.search(companyId, classNameIds, keywords, params, 553 start, end, obc); 554 } 555 556 @Override 557 public java.util.List<com.liferay.portal.kernel.model.Group> search( 558 long companyId, long[] classNameIds, java.lang.String name, 559 java.lang.String description, 560 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 561 boolean andOperator, int start, int end, 562 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc) 563 throws com.liferay.portal.kernel.exception.PortalException { 564 return _groupService.search(companyId, classNameIds, name, description, 565 params, andOperator, start, end, obc); 566 } 567 568 /** 569 * Adds the groups to the role. 570 * 571 * @param roleId the primary key of the role 572 * @param groupIds the primary keys of the groups 573 * @throws PortalException if a portal exception occurred 574 */ 575 @Override 576 public void addRoleGroups(long roleId, long[] groupIds) 577 throws com.liferay.portal.kernel.exception.PortalException { 578 _groupService.addRoleGroups(roleId, groupIds); 579 } 580 581 /** 582 * Checks that the current user is permitted to use the group for Remote 583 * Staging. 584 * 585 * @param groupId the primary key of the group 586 * @throws PortalException if a portal exception occurred 587 */ 588 @Override 589 public void checkRemoteStagingGroup(long groupId) 590 throws com.liferay.portal.kernel.exception.PortalException { 591 _groupService.checkRemoteStagingGroup(groupId); 592 } 593 594 /** 595 * Deletes the group. 596 * 597 * <p> 598 * The group is unstaged and its assets and resources including layouts, 599 * membership requests, subscriptions, teams, blogs, bookmarks, calendar 600 * events, image gallery, journals, message boards, polls, shopping related 601 * entities, and wikis are also deleted. 602 * </p> 603 * 604 * @param groupId the primary key of the group 605 * @throws PortalException if a portal exception occurred 606 */ 607 @Override 608 public void deleteGroup(long groupId) 609 throws com.liferay.portal.kernel.exception.PortalException { 610 _groupService.deleteGroup(groupId); 611 } 612 613 @Override 614 public void disableStaging(long groupId) 615 throws com.liferay.portal.kernel.exception.PortalException { 616 _groupService.disableStaging(groupId); 617 } 618 619 @Override 620 public void enableStaging(long groupId) 621 throws com.liferay.portal.kernel.exception.PortalException { 622 _groupService.enableStaging(groupId); 623 } 624 625 /** 626 * Sets the groups associated with the role, removing and adding 627 * associations as necessary. 628 * 629 * @param roleId the primary key of the role 630 * @param groupIds the primary keys of the groups 631 * @throws PortalException if a portal exception occurred 632 */ 633 @Override 634 public void setRoleGroups(long roleId, long[] groupIds) 635 throws com.liferay.portal.kernel.exception.PortalException { 636 _groupService.setRoleGroups(roleId, groupIds); 637 } 638 639 /** 640 * Removes the groups from the role. 641 * 642 * @param roleId the primary key of the role 643 * @param groupIds the primary keys of the groups 644 * @throws PortalException if a portal exception occurred 645 */ 646 @Override 647 public void unsetRoleGroups(long roleId, long[] groupIds) 648 throws com.liferay.portal.kernel.exception.PortalException { 649 _groupService.unsetRoleGroups(roleId, groupIds); 650 } 651 652 @Override 653 public void updateStagedPortlets(long groupId, 654 java.util.Map<java.lang.String, java.lang.String> stagedPortletIds) 655 throws com.liferay.portal.kernel.exception.PortalException { 656 _groupService.updateStagedPortlets(groupId, stagedPortletIds); 657 } 658 659 @Override 660 public GroupService getWrappedService() { 661 return _groupService; 662 } 663 664 @Override 665 public void setWrappedService(GroupService groupService) { 666 _groupService = groupService; 667 } 668 669 private GroupService _groupService; 670 }