001 /** 002 * Copyright (c) 2000-2013 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 /** 018 * <p> 019 * This class is a wrapper for {@link GroupLocalService}. 020 * </p> 021 * 022 * @author Brian Wing Shun Chan 023 * @see GroupLocalService 024 * @generated 025 */ 026 public class GroupLocalServiceWrapper implements GroupLocalService, 027 ServiceWrapper<GroupLocalService> { 028 public GroupLocalServiceWrapper(GroupLocalService groupLocalService) { 029 _groupLocalService = groupLocalService; 030 } 031 032 /** 033 * Adds the group to the database. Also notifies the appropriate model listeners. 034 * 035 * @param group the group 036 * @return the group that was added 037 * @throws SystemException if a system exception occurred 038 */ 039 public com.liferay.portal.model.Group addGroup( 040 com.liferay.portal.model.Group group) 041 throws com.liferay.portal.kernel.exception.SystemException { 042 return _groupLocalService.addGroup(group); 043 } 044 045 /** 046 * Creates a new group with the primary key. Does not add the group to the database. 047 * 048 * @param groupId the primary key for the new group 049 * @return the new group 050 */ 051 public com.liferay.portal.model.Group createGroup(long groupId) { 052 return _groupLocalService.createGroup(groupId); 053 } 054 055 /** 056 * Deletes the group with the primary key from the database. Also notifies the appropriate model listeners. 057 * 058 * @param groupId the primary key of the group 059 * @return the group that was removed 060 * @throws PortalException if a group with the primary key could not be found 061 * @throws SystemException if a system exception occurred 062 */ 063 public com.liferay.portal.model.Group deleteGroup(long groupId) 064 throws com.liferay.portal.kernel.exception.PortalException, 065 com.liferay.portal.kernel.exception.SystemException { 066 return _groupLocalService.deleteGroup(groupId); 067 } 068 069 /** 070 * Deletes the group from the database. Also notifies the appropriate model listeners. 071 * 072 * @param group the group 073 * @return the group that was removed 074 * @throws PortalException 075 * @throws SystemException if a system exception occurred 076 */ 077 public com.liferay.portal.model.Group deleteGroup( 078 com.liferay.portal.model.Group group) 079 throws com.liferay.portal.kernel.exception.PortalException, 080 com.liferay.portal.kernel.exception.SystemException { 081 return _groupLocalService.deleteGroup(group); 082 } 083 084 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 085 return _groupLocalService.dynamicQuery(); 086 } 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException { 099 return _groupLocalService.dynamicQuery(dynamicQuery); 100 } 101 102 /** 103 * Performs a dynamic query on the database and returns a range of the matching rows. 104 * 105 * <p> 106 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 107 * </p> 108 * 109 * @param dynamicQuery the dynamic query 110 * @param start the lower bound of the range of model instances 111 * @param end the upper bound of the range of model instances (not inclusive) 112 * @return the range of matching rows 113 * @throws SystemException if a system exception occurred 114 */ 115 @SuppressWarnings("rawtypes") 116 public java.util.List dynamicQuery( 117 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 118 int end) throws com.liferay.portal.kernel.exception.SystemException { 119 return _groupLocalService.dynamicQuery(dynamicQuery, start, end); 120 } 121 122 /** 123 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 124 * 125 * <p> 126 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 127 * </p> 128 * 129 * @param dynamicQuery the dynamic query 130 * @param start the lower bound of the range of model instances 131 * @param end the upper bound of the range of model instances (not inclusive) 132 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 133 * @return the ordered range of matching rows 134 * @throws SystemException if a system exception occurred 135 */ 136 @SuppressWarnings("rawtypes") 137 public java.util.List dynamicQuery( 138 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 139 int end, 140 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 141 throws com.liferay.portal.kernel.exception.SystemException { 142 return _groupLocalService.dynamicQuery(dynamicQuery, start, end, 143 orderByComparator); 144 } 145 146 /** 147 * Returns the number of rows that match the dynamic query. 148 * 149 * @param dynamicQuery the dynamic query 150 * @return the number of rows that match the dynamic query 151 * @throws SystemException if a system exception occurred 152 */ 153 public long dynamicQueryCount( 154 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 155 throws com.liferay.portal.kernel.exception.SystemException { 156 return _groupLocalService.dynamicQueryCount(dynamicQuery); 157 } 158 159 public com.liferay.portal.model.Group fetchGroup(long groupId) 160 throws com.liferay.portal.kernel.exception.SystemException { 161 return _groupLocalService.fetchGroup(groupId); 162 } 163 164 /** 165 * Returns the group with the primary key. 166 * 167 * @param groupId the primary key of the group 168 * @return the group 169 * @throws PortalException if a group with the primary key could not be found 170 * @throws SystemException if a system exception occurred 171 */ 172 public com.liferay.portal.model.Group getGroup(long groupId) 173 throws com.liferay.portal.kernel.exception.PortalException, 174 com.liferay.portal.kernel.exception.SystemException { 175 return _groupLocalService.getGroup(groupId); 176 } 177 178 public com.liferay.portal.model.PersistedModel getPersistedModel( 179 java.io.Serializable primaryKeyObj) 180 throws com.liferay.portal.kernel.exception.PortalException, 181 com.liferay.portal.kernel.exception.SystemException { 182 return _groupLocalService.getPersistedModel(primaryKeyObj); 183 } 184 185 /** 186 * Returns the group matching the UUID and group. 187 * 188 * @param uuid the group's UUID 189 * @param groupId the primary key of the group 190 * @return the matching group 191 * @throws PortalException if a matching group could not be found 192 * @throws SystemException if a system exception occurred 193 */ 194 public com.liferay.portal.model.Group getGroupByUuidAndGroupId( 195 java.lang.String uuid, long groupId) 196 throws com.liferay.portal.kernel.exception.PortalException, 197 com.liferay.portal.kernel.exception.SystemException { 198 return _groupLocalService.getGroupByUuidAndGroupId(uuid, groupId); 199 } 200 201 /** 202 * Returns a range of all the groups. 203 * 204 * <p> 205 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 206 * </p> 207 * 208 * @param start the lower bound of the range of groups 209 * @param end the upper bound of the range of groups (not inclusive) 210 * @return the range of groups 211 * @throws SystemException if a system exception occurred 212 */ 213 public java.util.List<com.liferay.portal.model.Group> getGroups(int start, 214 int end) throws com.liferay.portal.kernel.exception.SystemException { 215 return _groupLocalService.getGroups(start, end); 216 } 217 218 /** 219 * Returns the number of groups. 220 * 221 * @return the number of groups 222 * @throws SystemException if a system exception occurred 223 */ 224 public int getGroupsCount() 225 throws com.liferay.portal.kernel.exception.SystemException { 226 return _groupLocalService.getGroupsCount(); 227 } 228 229 /** 230 * Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 231 * 232 * @param group the group 233 * @return the group that was updated 234 * @throws SystemException if a system exception occurred 235 */ 236 public com.liferay.portal.model.Group updateGroup( 237 com.liferay.portal.model.Group group) 238 throws com.liferay.portal.kernel.exception.SystemException { 239 return _groupLocalService.updateGroup(group); 240 } 241 242 /** 243 * @throws SystemException if a system exception occurred 244 */ 245 public void addOrganizationGroup(long organizationId, long groupId) 246 throws com.liferay.portal.kernel.exception.SystemException { 247 _groupLocalService.addOrganizationGroup(organizationId, groupId); 248 } 249 250 /** 251 * @throws SystemException if a system exception occurred 252 */ 253 public void addOrganizationGroup(long organizationId, 254 com.liferay.portal.model.Group group) 255 throws com.liferay.portal.kernel.exception.SystemException { 256 _groupLocalService.addOrganizationGroup(organizationId, group); 257 } 258 259 /** 260 * @throws SystemException if a system exception occurred 261 */ 262 public void addOrganizationGroups(long organizationId, long[] groupIds) 263 throws com.liferay.portal.kernel.exception.SystemException { 264 _groupLocalService.addOrganizationGroups(organizationId, groupIds); 265 } 266 267 /** 268 * @throws SystemException if a system exception occurred 269 */ 270 public void addOrganizationGroups(long organizationId, 271 java.util.List<com.liferay.portal.model.Group> Groups) 272 throws com.liferay.portal.kernel.exception.SystemException { 273 _groupLocalService.addOrganizationGroups(organizationId, Groups); 274 } 275 276 /** 277 * @throws SystemException if a system exception occurred 278 */ 279 public void clearOrganizationGroups(long organizationId) 280 throws com.liferay.portal.kernel.exception.SystemException { 281 _groupLocalService.clearOrganizationGroups(organizationId); 282 } 283 284 /** 285 * @throws SystemException if a system exception occurred 286 */ 287 public void deleteOrganizationGroup(long organizationId, long groupId) 288 throws com.liferay.portal.kernel.exception.SystemException { 289 _groupLocalService.deleteOrganizationGroup(organizationId, groupId); 290 } 291 292 /** 293 * @throws SystemException if a system exception occurred 294 */ 295 public void deleteOrganizationGroup(long organizationId, 296 com.liferay.portal.model.Group group) 297 throws com.liferay.portal.kernel.exception.SystemException { 298 _groupLocalService.deleteOrganizationGroup(organizationId, group); 299 } 300 301 /** 302 * @throws SystemException if a system exception occurred 303 */ 304 public void deleteOrganizationGroups(long organizationId, long[] groupIds) 305 throws com.liferay.portal.kernel.exception.SystemException { 306 _groupLocalService.deleteOrganizationGroups(organizationId, groupIds); 307 } 308 309 /** 310 * @throws SystemException if a system exception occurred 311 */ 312 public void deleteOrganizationGroups(long organizationId, 313 java.util.List<com.liferay.portal.model.Group> Groups) 314 throws com.liferay.portal.kernel.exception.SystemException { 315 _groupLocalService.deleteOrganizationGroups(organizationId, Groups); 316 } 317 318 /** 319 * @throws SystemException if a system exception occurred 320 */ 321 public java.util.List<com.liferay.portal.model.Group> getOrganizationGroups( 322 long organizationId) 323 throws com.liferay.portal.kernel.exception.SystemException { 324 return _groupLocalService.getOrganizationGroups(organizationId); 325 } 326 327 /** 328 * @throws SystemException if a system exception occurred 329 */ 330 public java.util.List<com.liferay.portal.model.Group> getOrganizationGroups( 331 long organizationId, int start, int end) 332 throws com.liferay.portal.kernel.exception.SystemException { 333 return _groupLocalService.getOrganizationGroups(organizationId, start, 334 end); 335 } 336 337 /** 338 * @throws SystemException if a system exception occurred 339 */ 340 public java.util.List<com.liferay.portal.model.Group> getOrganizationGroups( 341 long organizationId, int start, int end, 342 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 343 throws com.liferay.portal.kernel.exception.SystemException { 344 return _groupLocalService.getOrganizationGroups(organizationId, start, 345 end, orderByComparator); 346 } 347 348 /** 349 * @throws SystemException if a system exception occurred 350 */ 351 public int getOrganizationGroupsCount(long organizationId) 352 throws com.liferay.portal.kernel.exception.SystemException { 353 return _groupLocalService.getOrganizationGroupsCount(organizationId); 354 } 355 356 /** 357 * @throws SystemException if a system exception occurred 358 */ 359 public boolean hasOrganizationGroup(long organizationId, long groupId) 360 throws com.liferay.portal.kernel.exception.SystemException { 361 return _groupLocalService.hasOrganizationGroup(organizationId, groupId); 362 } 363 364 /** 365 * @throws SystemException if a system exception occurred 366 */ 367 public boolean hasOrganizationGroups(long organizationId) 368 throws com.liferay.portal.kernel.exception.SystemException { 369 return _groupLocalService.hasOrganizationGroups(organizationId); 370 } 371 372 /** 373 * @throws SystemException if a system exception occurred 374 */ 375 public void setOrganizationGroups(long organizationId, long[] groupIds) 376 throws com.liferay.portal.kernel.exception.SystemException { 377 _groupLocalService.setOrganizationGroups(organizationId, groupIds); 378 } 379 380 /** 381 * @throws SystemException if a system exception occurred 382 */ 383 public void addRoleGroup(long roleId, long groupId) 384 throws com.liferay.portal.kernel.exception.SystemException { 385 _groupLocalService.addRoleGroup(roleId, groupId); 386 } 387 388 /** 389 * @throws SystemException if a system exception occurred 390 */ 391 public void addRoleGroup(long roleId, com.liferay.portal.model.Group group) 392 throws com.liferay.portal.kernel.exception.SystemException { 393 _groupLocalService.addRoleGroup(roleId, group); 394 } 395 396 /** 397 * @throws SystemException if a system exception occurred 398 */ 399 public void addRoleGroups(long roleId, long[] groupIds) 400 throws com.liferay.portal.kernel.exception.SystemException { 401 _groupLocalService.addRoleGroups(roleId, groupIds); 402 } 403 404 /** 405 * @throws SystemException if a system exception occurred 406 */ 407 public void addRoleGroups(long roleId, 408 java.util.List<com.liferay.portal.model.Group> Groups) 409 throws com.liferay.portal.kernel.exception.SystemException { 410 _groupLocalService.addRoleGroups(roleId, Groups); 411 } 412 413 /** 414 * @throws SystemException if a system exception occurred 415 */ 416 public void clearRoleGroups(long roleId) 417 throws com.liferay.portal.kernel.exception.SystemException { 418 _groupLocalService.clearRoleGroups(roleId); 419 } 420 421 /** 422 * @throws SystemException if a system exception occurred 423 */ 424 public void deleteRoleGroup(long roleId, long groupId) 425 throws com.liferay.portal.kernel.exception.SystemException { 426 _groupLocalService.deleteRoleGroup(roleId, groupId); 427 } 428 429 /** 430 * @throws SystemException if a system exception occurred 431 */ 432 public void deleteRoleGroup(long roleId, 433 com.liferay.portal.model.Group group) 434 throws com.liferay.portal.kernel.exception.SystemException { 435 _groupLocalService.deleteRoleGroup(roleId, group); 436 } 437 438 /** 439 * @throws SystemException if a system exception occurred 440 */ 441 public void deleteRoleGroups(long roleId, long[] groupIds) 442 throws com.liferay.portal.kernel.exception.SystemException { 443 _groupLocalService.deleteRoleGroups(roleId, groupIds); 444 } 445 446 /** 447 * @throws SystemException if a system exception occurred 448 */ 449 public void deleteRoleGroups(long roleId, 450 java.util.List<com.liferay.portal.model.Group> Groups) 451 throws com.liferay.portal.kernel.exception.SystemException { 452 _groupLocalService.deleteRoleGroups(roleId, Groups); 453 } 454 455 /** 456 * @throws SystemException if a system exception occurred 457 */ 458 public java.util.List<com.liferay.portal.model.Group> getRoleGroups( 459 long roleId) throws com.liferay.portal.kernel.exception.SystemException { 460 return _groupLocalService.getRoleGroups(roleId); 461 } 462 463 /** 464 * @throws SystemException if a system exception occurred 465 */ 466 public java.util.List<com.liferay.portal.model.Group> getRoleGroups( 467 long roleId, int start, int end) 468 throws com.liferay.portal.kernel.exception.SystemException { 469 return _groupLocalService.getRoleGroups(roleId, start, end); 470 } 471 472 /** 473 * @throws SystemException if a system exception occurred 474 */ 475 public java.util.List<com.liferay.portal.model.Group> getRoleGroups( 476 long roleId, int start, int end, 477 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 478 throws com.liferay.portal.kernel.exception.SystemException { 479 return _groupLocalService.getRoleGroups(roleId, start, end, 480 orderByComparator); 481 } 482 483 /** 484 * @throws SystemException if a system exception occurred 485 */ 486 public int getRoleGroupsCount(long roleId) 487 throws com.liferay.portal.kernel.exception.SystemException { 488 return _groupLocalService.getRoleGroupsCount(roleId); 489 } 490 491 /** 492 * @throws SystemException if a system exception occurred 493 */ 494 public boolean hasRoleGroup(long roleId, long groupId) 495 throws com.liferay.portal.kernel.exception.SystemException { 496 return _groupLocalService.hasRoleGroup(roleId, groupId); 497 } 498 499 /** 500 * @throws SystemException if a system exception occurred 501 */ 502 public boolean hasRoleGroups(long roleId) 503 throws com.liferay.portal.kernel.exception.SystemException { 504 return _groupLocalService.hasRoleGroups(roleId); 505 } 506 507 /** 508 * @throws SystemException if a system exception occurred 509 */ 510 public void setRoleGroups(long roleId, long[] groupIds) 511 throws com.liferay.portal.kernel.exception.SystemException { 512 _groupLocalService.setRoleGroups(roleId, groupIds); 513 } 514 515 /** 516 * @throws SystemException if a system exception occurred 517 */ 518 public void addUserGroupGroup(long userGroupId, long groupId) 519 throws com.liferay.portal.kernel.exception.SystemException { 520 _groupLocalService.addUserGroupGroup(userGroupId, groupId); 521 } 522 523 /** 524 * @throws SystemException if a system exception occurred 525 */ 526 public void addUserGroupGroup(long userGroupId, 527 com.liferay.portal.model.Group group) 528 throws com.liferay.portal.kernel.exception.SystemException { 529 _groupLocalService.addUserGroupGroup(userGroupId, group); 530 } 531 532 /** 533 * @throws SystemException if a system exception occurred 534 */ 535 public void addUserGroupGroups(long userGroupId, long[] groupIds) 536 throws com.liferay.portal.kernel.exception.SystemException { 537 _groupLocalService.addUserGroupGroups(userGroupId, groupIds); 538 } 539 540 /** 541 * @throws SystemException if a system exception occurred 542 */ 543 public void addUserGroupGroups(long userGroupId, 544 java.util.List<com.liferay.portal.model.Group> Groups) 545 throws com.liferay.portal.kernel.exception.SystemException { 546 _groupLocalService.addUserGroupGroups(userGroupId, Groups); 547 } 548 549 /** 550 * @throws SystemException if a system exception occurred 551 */ 552 public void clearUserGroupGroups(long userGroupId) 553 throws com.liferay.portal.kernel.exception.SystemException { 554 _groupLocalService.clearUserGroupGroups(userGroupId); 555 } 556 557 /** 558 * @throws SystemException if a system exception occurred 559 */ 560 public void deleteUserGroupGroup(long userGroupId, long groupId) 561 throws com.liferay.portal.kernel.exception.SystemException { 562 _groupLocalService.deleteUserGroupGroup(userGroupId, groupId); 563 } 564 565 /** 566 * @throws SystemException if a system exception occurred 567 */ 568 public void deleteUserGroupGroup(long userGroupId, 569 com.liferay.portal.model.Group group) 570 throws com.liferay.portal.kernel.exception.SystemException { 571 _groupLocalService.deleteUserGroupGroup(userGroupId, group); 572 } 573 574 /** 575 * @throws SystemException if a system exception occurred 576 */ 577 public void deleteUserGroupGroups(long userGroupId, long[] groupIds) 578 throws com.liferay.portal.kernel.exception.SystemException { 579 _groupLocalService.deleteUserGroupGroups(userGroupId, groupIds); 580 } 581 582 /** 583 * @throws SystemException if a system exception occurred 584 */ 585 public void deleteUserGroupGroups(long userGroupId, 586 java.util.List<com.liferay.portal.model.Group> Groups) 587 throws com.liferay.portal.kernel.exception.SystemException { 588 _groupLocalService.deleteUserGroupGroups(userGroupId, Groups); 589 } 590 591 /** 592 * @throws SystemException if a system exception occurred 593 */ 594 public java.util.List<com.liferay.portal.model.Group> getUserGroupGroups( 595 long userGroupId) 596 throws com.liferay.portal.kernel.exception.SystemException { 597 return _groupLocalService.getUserGroupGroups(userGroupId); 598 } 599 600 /** 601 * @throws SystemException if a system exception occurred 602 */ 603 public java.util.List<com.liferay.portal.model.Group> getUserGroupGroups( 604 long userGroupId, int start, int end) 605 throws com.liferay.portal.kernel.exception.SystemException { 606 return _groupLocalService.getUserGroupGroups(userGroupId, start, end); 607 } 608 609 /** 610 * @throws SystemException if a system exception occurred 611 */ 612 public java.util.List<com.liferay.portal.model.Group> getUserGroupGroups( 613 long userGroupId, int start, int end, 614 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 615 throws com.liferay.portal.kernel.exception.SystemException { 616 return _groupLocalService.getUserGroupGroups(userGroupId, start, end, 617 orderByComparator); 618 } 619 620 /** 621 * @throws SystemException if a system exception occurred 622 */ 623 public int getUserGroupGroupsCount(long userGroupId) 624 throws com.liferay.portal.kernel.exception.SystemException { 625 return _groupLocalService.getUserGroupGroupsCount(userGroupId); 626 } 627 628 /** 629 * @throws SystemException if a system exception occurred 630 */ 631 public boolean hasUserGroupGroup(long userGroupId, long groupId) 632 throws com.liferay.portal.kernel.exception.SystemException { 633 return _groupLocalService.hasUserGroupGroup(userGroupId, groupId); 634 } 635 636 /** 637 * @throws SystemException if a system exception occurred 638 */ 639 public boolean hasUserGroupGroups(long userGroupId) 640 throws com.liferay.portal.kernel.exception.SystemException { 641 return _groupLocalService.hasUserGroupGroups(userGroupId); 642 } 643 644 /** 645 * @throws SystemException if a system exception occurred 646 */ 647 public void setUserGroupGroups(long userGroupId, long[] groupIds) 648 throws com.liferay.portal.kernel.exception.SystemException { 649 _groupLocalService.setUserGroupGroups(userGroupId, groupIds); 650 } 651 652 /** 653 * @throws SystemException if a system exception occurred 654 */ 655 public void addUserGroup(long userId, long groupId) 656 throws com.liferay.portal.kernel.exception.SystemException { 657 _groupLocalService.addUserGroup(userId, groupId); 658 } 659 660 /** 661 * @throws SystemException if a system exception occurred 662 */ 663 public void addUserGroup(long userId, com.liferay.portal.model.Group group) 664 throws com.liferay.portal.kernel.exception.SystemException { 665 _groupLocalService.addUserGroup(userId, group); 666 } 667 668 /** 669 * @throws SystemException if a system exception occurred 670 */ 671 public void addUserGroups(long userId, long[] groupIds) 672 throws com.liferay.portal.kernel.exception.SystemException { 673 _groupLocalService.addUserGroups(userId, groupIds); 674 } 675 676 /** 677 * @throws SystemException if a system exception occurred 678 */ 679 public void addUserGroups(long userId, 680 java.util.List<com.liferay.portal.model.Group> Groups) 681 throws com.liferay.portal.kernel.exception.SystemException { 682 _groupLocalService.addUserGroups(userId, Groups); 683 } 684 685 /** 686 * @throws SystemException if a system exception occurred 687 */ 688 public void clearUserGroups(long userId) 689 throws com.liferay.portal.kernel.exception.SystemException { 690 _groupLocalService.clearUserGroups(userId); 691 } 692 693 /** 694 * @throws SystemException if a system exception occurred 695 */ 696 public void deleteUserGroup(long userId, long groupId) 697 throws com.liferay.portal.kernel.exception.SystemException { 698 _groupLocalService.deleteUserGroup(userId, groupId); 699 } 700 701 /** 702 * @throws SystemException if a system exception occurred 703 */ 704 public void deleteUserGroup(long userId, 705 com.liferay.portal.model.Group group) 706 throws com.liferay.portal.kernel.exception.SystemException { 707 _groupLocalService.deleteUserGroup(userId, group); 708 } 709 710 /** 711 * @throws SystemException if a system exception occurred 712 */ 713 public void deleteUserGroups(long userId, long[] groupIds) 714 throws com.liferay.portal.kernel.exception.SystemException { 715 _groupLocalService.deleteUserGroups(userId, groupIds); 716 } 717 718 /** 719 * @throws SystemException if a system exception occurred 720 */ 721 public void deleteUserGroups(long userId, 722 java.util.List<com.liferay.portal.model.Group> Groups) 723 throws com.liferay.portal.kernel.exception.SystemException { 724 _groupLocalService.deleteUserGroups(userId, Groups); 725 } 726 727 /** 728 * @throws SystemException if a system exception occurred 729 */ 730 public java.util.List<com.liferay.portal.model.Group> getUserGroups( 731 long userId) throws com.liferay.portal.kernel.exception.SystemException { 732 return _groupLocalService.getUserGroups(userId); 733 } 734 735 /** 736 * @throws SystemException if a system exception occurred 737 */ 738 public java.util.List<com.liferay.portal.model.Group> getUserGroups( 739 long userId, int start, int end) 740 throws com.liferay.portal.kernel.exception.SystemException { 741 return _groupLocalService.getUserGroups(userId, start, end); 742 } 743 744 /** 745 * @throws PortalException 746 * @throws SystemException if a system exception occurred 747 */ 748 public java.util.List<com.liferay.portal.model.Group> getUserGroups( 749 long userId, int start, int end, 750 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 751 throws com.liferay.portal.kernel.exception.PortalException, 752 com.liferay.portal.kernel.exception.SystemException { 753 return _groupLocalService.getUserGroups(userId, start, end, 754 orderByComparator); 755 } 756 757 /** 758 * @throws SystemException if a system exception occurred 759 */ 760 public int getUserGroupsCount(long userId) 761 throws com.liferay.portal.kernel.exception.SystemException { 762 return _groupLocalService.getUserGroupsCount(userId); 763 } 764 765 /** 766 * @throws SystemException if a system exception occurred 767 */ 768 public boolean hasUserGroup(long userId, long groupId) 769 throws com.liferay.portal.kernel.exception.SystemException { 770 return _groupLocalService.hasUserGroup(userId, groupId); 771 } 772 773 /** 774 * @throws SystemException if a system exception occurred 775 */ 776 public boolean hasUserGroups(long userId) 777 throws com.liferay.portal.kernel.exception.SystemException { 778 return _groupLocalService.hasUserGroups(userId); 779 } 780 781 /** 782 * @throws SystemException if a system exception occurred 783 */ 784 public void setUserGroups(long userId, long[] groupIds) 785 throws com.liferay.portal.kernel.exception.SystemException { 786 _groupLocalService.setUserGroups(userId, groupIds); 787 } 788 789 /** 790 * Returns the Spring bean ID for this bean. 791 * 792 * @return the Spring bean ID for this bean 793 */ 794 public java.lang.String getBeanIdentifier() { 795 return _groupLocalService.getBeanIdentifier(); 796 } 797 798 /** 799 * Sets the Spring bean ID for this bean. 800 * 801 * @param beanIdentifier the Spring bean ID for this bean 802 */ 803 public void setBeanIdentifier(java.lang.String beanIdentifier) { 804 _groupLocalService.setBeanIdentifier(beanIdentifier); 805 } 806 807 /** 808 * Adds a group. 809 * 810 * @param userId the primary key of the group's creator/owner 811 * @param parentGroupId the primary key of the parent group 812 * @param className the entity's class name 813 * @param classPK the primary key of the entity's instance 814 * @param liveGroupId the primary key of the live group 815 * @param name the entity's name 816 * @param description the group's description (optionally 817 <code>null</code>) 818 * @param type the group's type. For more information see {@link 819 com.liferay.portal.model.GroupConstants} 820 * @param friendlyURL the group's friendlyURL (optionally 821 <code>null</code>) 822 * @param site whether the group is to be associated with a main site 823 * @param active whether the group is active 824 * @param serviceContext the service context to be applied (optionally 825 <code>null</code>). Can set asset category IDs and asset tag 826 names for the group, and whether the group is for staging. 827 * @return the group 828 * @throws PortalException if a creator could not be found, if the group's 829 information was invalid, if a layout could not be found, or if a 830 valid friendly URL could not be created for the group 831 * @throws SystemException if a system exception occurred 832 */ 833 public com.liferay.portal.model.Group addGroup(long userId, 834 long parentGroupId, java.lang.String className, long classPK, 835 long liveGroupId, java.lang.String name, java.lang.String description, 836 int type, java.lang.String friendlyURL, boolean site, boolean active, 837 com.liferay.portal.service.ServiceContext serviceContext) 838 throws com.liferay.portal.kernel.exception.PortalException, 839 com.liferay.portal.kernel.exception.SystemException { 840 return _groupLocalService.addGroup(userId, parentGroupId, className, 841 classPK, liveGroupId, name, description, type, friendlyURL, site, 842 active, serviceContext); 843 } 844 845 /** 846 * Adds the group using the default live group. 847 * 848 * @param userId the primary key of the group's creator/owner 849 * @param parentGroupId the primary key of the parent group 850 * @param className the entity's class name 851 * @param classPK the primary key of the entity's instance 852 * @param name the entity's name 853 * @param description the group's description (optionally 854 <code>null</code>) 855 * @param type the group's type. For more information see {@link 856 com.liferay.portal.model.GroupConstants} 857 * @param friendlyURL the group's friendlyURL 858 * @param site whether the group is to be associated with a main site 859 * @param active whether the group is active 860 * @param serviceContext the service context to be applied (optionally 861 <code>null</code>). Can set asset category IDs and asset tag 862 names for the group, and whether the group is for staging. 863 * @return the group 864 * @throws PortalException if a creator could not be found, if the 865 group's information was invalid, if a layout could not be 866 found, or if a valid friendly URL could not be created for 867 the group 868 * @throws SystemException if a system exception occurred 869 * @deprecated As of 6.2.0, replaced by {@link #addGroup(long, long, String, 870 long, long, String, String, int, String, boolean, boolean, 871 ServiceContext)} 872 */ 873 public com.liferay.portal.model.Group addGroup(long userId, 874 long parentGroupId, java.lang.String className, long classPK, 875 java.lang.String name, java.lang.String description, int type, 876 java.lang.String friendlyURL, boolean site, boolean active, 877 com.liferay.portal.service.ServiceContext serviceContext) 878 throws com.liferay.portal.kernel.exception.PortalException, 879 com.liferay.portal.kernel.exception.SystemException { 880 return _groupLocalService.addGroup(userId, parentGroupId, className, 881 classPK, name, description, type, friendlyURL, site, active, 882 serviceContext); 883 } 884 885 /** 886 * Adds a company group if it does not exist. This method is typically used 887 * when a virtual host is added. 888 * 889 * @param companyId the primary key of the company 890 * @throws PortalException if a default user for the company could not be 891 found, if the group's information was invalid, if a layout could 892 not be found, or if a valid friendly URL could not be created for 893 the group 894 * @throws SystemException if a system exception occurred 895 */ 896 public void checkCompanyGroup(long companyId) 897 throws com.liferay.portal.kernel.exception.PortalException, 898 com.liferay.portal.kernel.exception.SystemException { 899 _groupLocalService.checkCompanyGroup(companyId); 900 } 901 902 /** 903 * Creates systems groups and other related data needed by the system on the 904 * very first startup. Also takes care of creating the Control Panel groups 905 * and layouts. 906 * 907 * @param companyId the primary key of the company 908 * @throws PortalException if a new system group could not be created 909 * @throws SystemException if a system exception occurred 910 */ 911 public void checkSystemGroups(long companyId) 912 throws com.liferay.portal.kernel.exception.PortalException, 913 com.liferay.portal.kernel.exception.SystemException { 914 _groupLocalService.checkSystemGroups(companyId); 915 } 916 917 /** 918 * Returns the group with the matching friendly URL. 919 * 920 * @param companyId the primary key of the company 921 * @param friendlyURL the friendly URL 922 * @return the group with the friendly URL, or <code>null</code> if a 923 matching group could not be found 924 * @throws SystemException if a system exception occurred 925 */ 926 public com.liferay.portal.model.Group fetchFriendlyURLGroup( 927 long companyId, java.lang.String friendlyURL) 928 throws com.liferay.portal.kernel.exception.SystemException { 929 return _groupLocalService.fetchFriendlyURLGroup(companyId, friendlyURL); 930 } 931 932 /** 933 * Returns the group with the matching group name by first searching the 934 * system groups and then using the finder cache. 935 * 936 * @param companyId the primary key of the company 937 * @param name the group's name 938 * @return the group with the name and associated company, or 939 <code>null</code> if a matching group could not be found 940 * @throws SystemException if a system exception occurred 941 */ 942 public com.liferay.portal.model.Group fetchGroup(long companyId, 943 java.lang.String name) 944 throws com.liferay.portal.kernel.exception.SystemException { 945 return _groupLocalService.fetchGroup(companyId, name); 946 } 947 948 /** 949 * Returns the group with the matching UUID and company. 950 * 951 * @param uuid the UUID 952 * @param companyId the primary key of the company 953 * @return the matching group, or <code>null</code> if a matching group 954 could not be found 955 * @throws SystemException if a system exception occurred 956 */ 957 public com.liferay.portal.model.Group fetchGroupByUuidandCompanyId( 958 java.lang.String uuid, long companyId) 959 throws com.liferay.portal.kernel.exception.SystemException { 960 return _groupLocalService.fetchGroupByUuidandCompanyId(uuid, companyId); 961 } 962 963 /** 964 * Returns the company group. 965 * 966 * @param companyId the primary key of the company 967 * @return the group associated with the company 968 * @throws PortalException if a matching group could not be found 969 * @throws SystemException if a system exception occurred 970 */ 971 public com.liferay.portal.model.Group getCompanyGroup(long companyId) 972 throws com.liferay.portal.kernel.exception.PortalException, 973 com.liferay.portal.kernel.exception.SystemException { 974 return _groupLocalService.getCompanyGroup(companyId); 975 } 976 977 /** 978 * Returns a range of all the groups associated with the company. 979 * 980 * <p> 981 * Useful when paginating results. Returns a maximum of <code>end - 982 * start</code> instances. <code>start</code> and <code>end</code> are not 983 * primary keys, they are indexes in the result set. Thus, <code>0</code> 984 * refers to the first result in the set. Setting both <code>start</code> 985 * and <code>end</code> to {@link 986 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 987 * result set. 988 * </p> 989 * 990 * @param companyId the primary key of the company 991 * @param start the lower bound of the range of groups to return 992 * @param end the upper bound of the range of groups to return (not 993 inclusive) 994 * @return the range of groups associated with the company 995 * @throws SystemException if a system exception occurred 996 */ 997 public java.util.List<com.liferay.portal.model.Group> getCompanyGroups( 998 long companyId, int start, int end) 999 throws com.liferay.portal.kernel.exception.SystemException { 1000 return _groupLocalService.getCompanyGroups(companyId, start, end); 1001 } 1002 1003 /** 1004 * Returns the number of groups associated with the company. 1005 * 1006 * @param companyId the primary key of the company 1007 * @return the number of groups associated with the company 1008 * @throws SystemException if a system exception occurred 1009 */ 1010 public int getCompanyGroupsCount(long companyId) 1011 throws com.liferay.portal.kernel.exception.SystemException { 1012 return _groupLocalService.getCompanyGroupsCount(companyId); 1013 } 1014 1015 /** 1016 * Returns the group with the matching friendly URL. 1017 * 1018 * @param companyId the primary key of the company 1019 * @param friendlyURL the group's friendlyURL 1020 * @return the group with the friendly URL 1021 * @throws PortalException if a matching group could not be found, or if the 1022 friendly URL was invalid 1023 * @throws SystemException if a system exception occurred 1024 */ 1025 public com.liferay.portal.model.Group getFriendlyURLGroup(long companyId, 1026 java.lang.String friendlyURL) 1027 throws com.liferay.portal.kernel.exception.PortalException, 1028 com.liferay.portal.kernel.exception.SystemException { 1029 return _groupLocalService.getFriendlyURLGroup(companyId, friendlyURL); 1030 } 1031 1032 /** 1033 * Returns the group with the matching group name. 1034 * 1035 * @param companyId the primary key of the company 1036 * @param name the group's name 1037 * @return the group with the name 1038 * @throws PortalException if a matching group could not be found 1039 * @throws SystemException if a system exception occurred 1040 */ 1041 public com.liferay.portal.model.Group getGroup(long companyId, 1042 java.lang.String name) 1043 throws com.liferay.portal.kernel.exception.PortalException, 1044 com.liferay.portal.kernel.exception.SystemException { 1045 return _groupLocalService.getGroup(companyId, name); 1046 } 1047 1048 public java.lang.String getGroupDescriptiveName( 1049 com.liferay.portal.model.Group group, java.util.Locale locale) 1050 throws com.liferay.portal.kernel.exception.PortalException, 1051 com.liferay.portal.kernel.exception.SystemException { 1052 return _groupLocalService.getGroupDescriptiveName(group, locale); 1053 } 1054 1055 public java.lang.String getGroupDescriptiveName(long groupId, 1056 java.util.Locale locale) 1057 throws com.liferay.portal.kernel.exception.PortalException, 1058 com.liferay.portal.kernel.exception.SystemException { 1059 return _groupLocalService.getGroupDescriptiveName(groupId, locale); 1060 } 1061 1062 /** 1063 * Returns all the groups that are direct children of the parent group. 1064 * 1065 * @param companyId the primary key of the company 1066 * @param parentGroupId the primary key of the parent group 1067 * @param site whether the group is to be associated with a main site 1068 * @return the matching groups, or <code>null</code> if no matches were 1069 found 1070 * @throws SystemException if a system exception occurred 1071 */ 1072 public java.util.List<com.liferay.portal.model.Group> getGroups( 1073 long companyId, long parentGroupId, boolean site) 1074 throws com.liferay.portal.kernel.exception.SystemException { 1075 return _groupLocalService.getGroups(companyId, parentGroupId, site); 1076 } 1077 1078 /** 1079 * Returns all the groups that are direct children of the parent group with 1080 * the matching className. 1081 * 1082 * @param companyId the primary key of the company 1083 * @param className the class name of the group 1084 * @param parentGroupId the primary key of the parent group 1085 * @return the matching groups, or <code>null</code> if no matches were 1086 found 1087 * @throws SystemException if a system exception occurred 1088 */ 1089 public java.util.List<com.liferay.portal.model.Group> getGroups( 1090 long companyId, java.lang.String className, long parentGroupId) 1091 throws com.liferay.portal.kernel.exception.SystemException { 1092 return _groupLocalService.getGroups(companyId, className, parentGroupId); 1093 } 1094 1095 /** 1096 * Returns a range of all the groups that are direct children of the parent 1097 * group with the matching className. 1098 * 1099 * @param companyId the primary key of the company 1100 * @param className the class name of the group 1101 * @param parentGroupId the primary key of the parent group 1102 * @param start the lower bound of the range of results 1103 * @param end the upper bound of the range of results (not inclusive) 1104 * @return the range of matching groups 1105 * @throws SystemException if a system exception occurred 1106 */ 1107 public java.util.List<com.liferay.portal.model.Group> getGroups( 1108 long companyId, java.lang.String className, long parentGroupId, 1109 int start, int end) 1110 throws com.liferay.portal.kernel.exception.SystemException { 1111 return _groupLocalService.getGroups(companyId, className, 1112 parentGroupId, start, end); 1113 } 1114 1115 /** 1116 * Returns the groups with the matching primary keys. 1117 * 1118 * @param groupIds the primary keys of the groups 1119 * @return the groups with the primary keys 1120 * @throws PortalException if any one of the groups could not be found 1121 * @throws SystemException if a system exception occurred 1122 */ 1123 public java.util.List<com.liferay.portal.model.Group> getGroups( 1124 long[] groupIds) 1125 throws com.liferay.portal.kernel.exception.PortalException, 1126 com.liferay.portal.kernel.exception.SystemException { 1127 return _groupLocalService.getGroups(groupIds); 1128 } 1129 1130 /** 1131 * Returns the number of groups that are direct children of the parent 1132 * group. 1133 * 1134 * @param companyId the primary key of the company 1135 * @param parentGroupId the primary key of the parent group 1136 * @param site whether the group is to be associated with a main site 1137 * @return the number of matching groups 1138 * @throws SystemException if a system exception occurred 1139 */ 1140 public int getGroupsCount(long companyId, long parentGroupId, boolean site) 1141 throws com.liferay.portal.kernel.exception.SystemException { 1142 return _groupLocalService.getGroupsCount(companyId, parentGroupId, site); 1143 } 1144 1145 /** 1146 * Returns the number of groups that are direct children of the parent group 1147 * with the matching className. 1148 * 1149 * @param companyId the primary key of the company 1150 * @param className the class name of the group 1151 * @param parentGroupId the primary key of the parent group 1152 * @return the number of matching groups 1153 * @throws SystemException if a system exception occurred 1154 */ 1155 public int getGroupsCount(long companyId, java.lang.String className, 1156 long parentGroupId) 1157 throws com.liferay.portal.kernel.exception.SystemException { 1158 return _groupLocalService.getGroupsCount(companyId, className, 1159 parentGroupId); 1160 } 1161 1162 /** 1163 * Returns the group associated with the layout. 1164 * 1165 * @param companyId the primary key of the company 1166 * @param plid the primary key of the layout 1167 * @return the group associated with the layout 1168 * @throws PortalException if a matching group could not be found 1169 * @throws SystemException if a system exception occurred 1170 */ 1171 public com.liferay.portal.model.Group getLayoutGroup(long companyId, 1172 long plid) 1173 throws com.liferay.portal.kernel.exception.PortalException, 1174 com.liferay.portal.kernel.exception.SystemException { 1175 return _groupLocalService.getLayoutGroup(companyId, plid); 1176 } 1177 1178 /** 1179 * Returns the group associated with the layout prototype. 1180 * 1181 * @param companyId the primary key of the company 1182 * @param layoutPrototypeId the primary key of the layout prototype 1183 * @return the group associated with the layout prototype 1184 * @throws PortalException if a matching group could not be found 1185 * @throws SystemException if a system exception occurred 1186 */ 1187 public com.liferay.portal.model.Group getLayoutPrototypeGroup( 1188 long companyId, long layoutPrototypeId) 1189 throws com.liferay.portal.kernel.exception.PortalException, 1190 com.liferay.portal.kernel.exception.SystemException { 1191 return _groupLocalService.getLayoutPrototypeGroup(companyId, 1192 layoutPrototypeId); 1193 } 1194 1195 /** 1196 * Returns the group associated with the layout set prototype. 1197 * 1198 * @param companyId the primary key of the company 1199 * @param layoutSetPrototypeId the primary key of the layout set prototype 1200 * @return the group associated with the layout set prototype 1201 * @throws PortalException if a matching group could not be found 1202 * @throws SystemException if a system exception occurred 1203 */ 1204 public com.liferay.portal.model.Group getLayoutSetPrototypeGroup( 1205 long companyId, long layoutSetPrototypeId) 1206 throws com.liferay.portal.kernel.exception.PortalException, 1207 com.liferay.portal.kernel.exception.SystemException { 1208 return _groupLocalService.getLayoutSetPrototypeGroup(companyId, 1209 layoutSetPrototypeId); 1210 } 1211 1212 /** 1213 * Returns a range of all groups that are children of the parent group and 1214 * that have at least one layout. 1215 * 1216 * <p> 1217 * Useful when paginating results. Returns a maximum of <code>end - 1218 * start</code> instances. <code>start</code> and <code>end</code> are not 1219 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1220 * refers to the first result in the set. Setting both <code>start</code> 1221 * and <code>end</code> to {@link 1222 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1223 * result set. 1224 * </p> 1225 * 1226 * @param companyId the primary key of the company 1227 * @param parentGroupId the primary key of the parent group 1228 * @param site whether the group is to be associated with a main site 1229 * @param start the lower bound of the range of groups to return 1230 * @param end the upper bound of the range of groups to return (not 1231 inclusive) 1232 * @return the range of matching groups 1233 * @throws SystemException if a system exception occurred 1234 */ 1235 public java.util.List<com.liferay.portal.model.Group> getLayoutsGroups( 1236 long companyId, long parentGroupId, boolean site, int start, int end) 1237 throws com.liferay.portal.kernel.exception.SystemException { 1238 return _groupLocalService.getLayoutsGroups(companyId, parentGroupId, 1239 site, start, end); 1240 } 1241 1242 /** 1243 * Returns the number of groups that are children or the parent group and 1244 * that have at least one layout 1245 * 1246 * @param companyId the primary key of the company 1247 * @param parentGroupId the primary key of the parent group 1248 * @param site whether the group is to be associated with a main site 1249 * @return the number of matching groups 1250 * @throws SystemException if a system exception occurred 1251 */ 1252 public int getLayoutsGroupsCount(long companyId, long parentGroupId, 1253 boolean site) 1254 throws com.liferay.portal.kernel.exception.SystemException { 1255 return _groupLocalService.getLayoutsGroupsCount(companyId, 1256 parentGroupId, site); 1257 } 1258 1259 /** 1260 * Returns all live groups. 1261 * 1262 * @return all live groups 1263 * @throws SystemException if a system exception occurred 1264 */ 1265 public java.util.List<com.liferay.portal.model.Group> getLiveGroups() 1266 throws com.liferay.portal.kernel.exception.SystemException { 1267 return _groupLocalService.getLiveGroups(); 1268 } 1269 1270 /** 1271 * Returns a range of all non-system groups of a specified type (className) 1272 * that have no layouts. 1273 * 1274 * <p> 1275 * Useful when paginating results. Returns a maximum of <code>end - 1276 * start</code> instances. <code>start</code> and <code>end</code> are not 1277 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1278 * refers to the first result in the set. Setting both <code>start</code> 1279 * and <code>end</code> to {@link 1280 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1281 * result set. 1282 * </p> 1283 * 1284 * @param className the entity's class name 1285 * @param privateLayout whether to include groups with private layout sets 1286 or non-private layout sets 1287 * @param start the lower bound of the range of groups to return 1288 * @param end the upper bound of the range of groups to return (not 1289 inclusive) 1290 * @return the range of matching groups 1291 * @throws SystemException if a system exception occurred 1292 */ 1293 public java.util.List<com.liferay.portal.model.Group> getNoLayoutsGroups( 1294 java.lang.String className, boolean privateLayout, int start, int end) 1295 throws com.liferay.portal.kernel.exception.SystemException { 1296 return _groupLocalService.getNoLayoutsGroups(className, privateLayout, 1297 start, end); 1298 } 1299 1300 /** 1301 * Returns all non-system groups having <code>null</code> or empty friendly 1302 * URLs. 1303 * 1304 * @return the non-system groups having <code>null</code> or empty friendly 1305 URLs 1306 * @throws SystemException if a system exception occurred 1307 */ 1308 public java.util.List<com.liferay.portal.model.Group> getNullFriendlyURLGroups() 1309 throws com.liferay.portal.kernel.exception.SystemException { 1310 return _groupLocalService.getNullFriendlyURLGroups(); 1311 } 1312 1313 /** 1314 * Returns the specified organization group. 1315 * 1316 * @param companyId the primary key of the company 1317 * @param organizationId the primary key of the organization 1318 * @return the group associated with the organization 1319 * @throws PortalException if a matching group could not be found 1320 * @throws SystemException if a system exception occurred 1321 */ 1322 public com.liferay.portal.model.Group getOrganizationGroup(long companyId, 1323 long organizationId) 1324 throws com.liferay.portal.kernel.exception.PortalException, 1325 com.liferay.portal.kernel.exception.SystemException { 1326 return _groupLocalService.getOrganizationGroup(companyId, organizationId); 1327 } 1328 1329 /** 1330 * Returns the specified organization groups. 1331 * 1332 * @param organizations the organizations 1333 * @return the groups associated with the organizations 1334 */ 1335 public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups( 1336 java.util.List<com.liferay.portal.model.Organization> organizations) { 1337 return _groupLocalService.getOrganizationsGroups(organizations); 1338 } 1339 1340 /** 1341 * Returns all the groups related to the organizations. 1342 * 1343 * @param organizations the organizations 1344 * @return the groups related to the organizations 1345 * @throws SystemException if a system exception occurred 1346 */ 1347 public java.util.List<com.liferay.portal.model.Group> getOrganizationsRelatedGroups( 1348 java.util.List<com.liferay.portal.model.Organization> organizations) 1349 throws com.liferay.portal.kernel.exception.SystemException { 1350 return _groupLocalService.getOrganizationsRelatedGroups(organizations); 1351 } 1352 1353 /** 1354 * Returns the group followed by all its parent groups ordered by closest 1355 * ancestor. 1356 * 1357 * @param groupId the primary key of the group 1358 * @return the group followed by all its parent groups ordered by closest 1359 ancestor 1360 * @throws PortalException if a group with the primary key could not be 1361 found 1362 * @throws SystemException if a system exception occurred 1363 */ 1364 public java.util.List<com.liferay.portal.model.Group> getParentGroups( 1365 long groupId) 1366 throws com.liferay.portal.kernel.exception.PortalException, 1367 com.liferay.portal.kernel.exception.SystemException { 1368 return _groupLocalService.getParentGroups(groupId); 1369 } 1370 1371 /** 1372 * Returns the staging group. 1373 * 1374 * @param liveGroupId the primary key of the live group 1375 * @return the staging group 1376 * @throws PortalException if a matching staging group could not be found 1377 * @throws SystemException if a system exception occurred 1378 */ 1379 public com.liferay.portal.model.Group getStagingGroup(long liveGroupId) 1380 throws com.liferay.portal.kernel.exception.PortalException, 1381 com.liferay.portal.kernel.exception.SystemException { 1382 return _groupLocalService.getStagingGroup(liveGroupId); 1383 } 1384 1385 /** 1386 * Returns the group associated with the user. 1387 * 1388 * @param companyId the primary key of the company 1389 * @param userId the primary key of the user 1390 * @return the group associated with the user 1391 * @throws PortalException if a matching group could not be found 1392 * @throws SystemException if a system exception occurred 1393 */ 1394 public com.liferay.portal.model.Group getUserGroup(long companyId, 1395 long userId) 1396 throws com.liferay.portal.kernel.exception.PortalException, 1397 com.liferay.portal.kernel.exception.SystemException { 1398 return _groupLocalService.getUserGroup(companyId, userId); 1399 } 1400 1401 /** 1402 * Returns the specified "user group" group. That is, the group that 1403 * represents the {@link com.liferay.portal.model.UserGroup} entity. 1404 * 1405 * @param companyId the primary key of the company 1406 * @param userGroupId the primary key of the user group 1407 * @return the group associated with the user group 1408 * @throws PortalException if a matching group could not be found 1409 * @throws SystemException if a system exception occurred 1410 */ 1411 public com.liferay.portal.model.Group getUserGroupGroup(long companyId, 1412 long userGroupId) 1413 throws com.liferay.portal.kernel.exception.PortalException, 1414 com.liferay.portal.kernel.exception.SystemException { 1415 return _groupLocalService.getUserGroupGroup(companyId, userGroupId); 1416 } 1417 1418 /** 1419 * Returns all the user's site groups and immediate organization groups, 1420 * optionally including the user's inherited organization groups and user 1421 * groups. System and staged groups are not included. 1422 * 1423 * @param userId the primary key of the user 1424 * @param inherit whether to include the user's inherited organization 1425 groups and user groups 1426 * @return the user's groups and immediate organization groups 1427 * @throws PortalException if a user with the primary key could not be found 1428 * @throws SystemException if a system exception occurred 1429 */ 1430 public java.util.List<com.liferay.portal.model.Group> getUserGroups( 1431 long userId, boolean inherit) 1432 throws com.liferay.portal.kernel.exception.PortalException, 1433 com.liferay.portal.kernel.exception.SystemException { 1434 return _groupLocalService.getUserGroups(userId, inherit); 1435 } 1436 1437 /** 1438 * Returns an ordered range of all the user's site groups and immediate 1439 * organization groups, optionally including the user's inherited 1440 * organization groups and user groups. System and staged groups are not 1441 * included. 1442 * 1443 * <p> 1444 * Useful when paginating results. Returns a maximum of <code>end - 1445 * start</code> instances. <code>start</code> and <code>end</code> are not 1446 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1447 * refers to the first result in the set. Setting both <code>start</code> 1448 * and <code>end</code> to {@link 1449 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1450 * result set. 1451 * </p> 1452 * 1453 * @param userId the primary key of the user 1454 * @param inherit whether to include the user's inherited organization 1455 groups and user groups 1456 * @param start the lower bound of the range of groups to return 1457 * @param end the upper bound of the range of groups to return (not 1458 inclusive) 1459 * @return the range of the user's groups and immediate organization groups 1460 ordered by name 1461 * @throws PortalException if a user with the primary key could not be found 1462 * @throws SystemException if a system exception occurred 1463 */ 1464 public java.util.List<com.liferay.portal.model.Group> getUserGroups( 1465 long userId, boolean inherit, int start, int end) 1466 throws com.liferay.portal.kernel.exception.PortalException, 1467 com.liferay.portal.kernel.exception.SystemException { 1468 return _groupLocalService.getUserGroups(userId, inherit, start, end); 1469 } 1470 1471 /** 1472 * Returns the groups associated with the user groups. 1473 * 1474 * @param userGroups the user groups 1475 * @return the groups associated with the user groups 1476 * @throws PortalException if any one of the user group's group could not be 1477 found 1478 * @throws SystemException if a system exception occurred 1479 */ 1480 public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups( 1481 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 1482 throws com.liferay.portal.kernel.exception.PortalException, 1483 com.liferay.portal.kernel.exception.SystemException { 1484 return _groupLocalService.getUserGroupsGroups(userGroups); 1485 } 1486 1487 /** 1488 * Returns all the groups related to the user groups. 1489 * 1490 * @param userGroups the user groups 1491 * @return the groups related to the user groups 1492 * @throws SystemException if a system exception occurred 1493 */ 1494 public java.util.List<com.liferay.portal.model.Group> getUserGroupsRelatedGroups( 1495 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 1496 throws com.liferay.portal.kernel.exception.SystemException { 1497 return _groupLocalService.getUserGroupsRelatedGroups(userGroups); 1498 } 1499 1500 /** 1501 * Returns the range of all groups associated with the user's organization 1502 * groups, including the ancestors of the organization groups, unless portal 1503 * property <code>organizations.membership.strict</code> is set to 1504 * <code>true</code>. 1505 * 1506 * <p> 1507 * Useful when paginating results. Returns a maximum of <code>end - 1508 * start</code> instances. <code>start</code> and <code>end</code> are not 1509 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1510 * refers to the first result in the set. Setting both <code>start</code> 1511 * and <code>end</code> to {@link 1512 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1513 * result set. 1514 * </p> 1515 * 1516 * @param userId the primary key of the user 1517 * @param start the lower bound of the range of groups to consider 1518 * @param end the upper bound of the range of groups to consider (not 1519 inclusive) 1520 * @return the range of groups associated with the user's organization 1521 groups 1522 * @throws PortalException if a user with the primary key could not be found 1523 or if another portal exception occurred 1524 * @throws SystemException if a system exception occurred 1525 */ 1526 public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups( 1527 long userId, int start, int end) 1528 throws com.liferay.portal.kernel.exception.PortalException, 1529 com.liferay.portal.kernel.exception.SystemException { 1530 return _groupLocalService.getUserOrganizationsGroups(userId, start, end); 1531 } 1532 1533 /** 1534 * Returns <code>true</code> if the live group has a staging group. 1535 * 1536 * @param liveGroupId the primary key of the live group 1537 * @return <code>true</code> if the live group has a staging group; 1538 <code>false</code> otherwise 1539 * @throws SystemException if a system exception occurred 1540 */ 1541 public boolean hasStagingGroup(long liveGroupId) 1542 throws com.liferay.portal.kernel.exception.SystemException { 1543 return _groupLocalService.hasStagingGroup(liveGroupId); 1544 } 1545 1546 /** 1547 * Returns <code>true</code> if the user is immediately associated with the 1548 * group, or optionally if the user is associated with the group via the 1549 * user's organizations, inherited organizations, or user groups. 1550 * 1551 * @param userId the primary key of the user 1552 * @param groupId the primary key of the group 1553 * @param inherit whether to include organization groups and user groups to 1554 which the user belongs in the determination 1555 * @return <code>true</code> if the user is associated with the group; 1556 <code>false</code> otherwise 1557 * @throws SystemException if a system exception occurred 1558 */ 1559 public boolean hasUserGroup(long userId, long groupId, boolean inherit) 1560 throws com.liferay.portal.kernel.exception.SystemException { 1561 return _groupLocalService.hasUserGroup(userId, groupId, inherit); 1562 } 1563 1564 /** 1565 * Returns the group with the matching group name by first searching the 1566 * system groups and then using the finder cache. 1567 * 1568 * @param companyId the primary key of the company 1569 * @param name the group's name 1570 * @return the group with the name and associated company, or 1571 <code>null</code> if a matching group could not be found 1572 * @throws SystemException if a system exception occurred 1573 */ 1574 public com.liferay.portal.model.Group loadFetchGroup(long companyId, 1575 java.lang.String name) 1576 throws com.liferay.portal.kernel.exception.SystemException { 1577 return _groupLocalService.loadFetchGroup(companyId, name); 1578 } 1579 1580 /** 1581 * Returns the group with the matching group name. 1582 * 1583 * @param companyId the primary key of the company 1584 * @param name the group's name 1585 * @return the group with the name and associated company 1586 * @throws PortalException if a matching group could not be found 1587 * @throws SystemException if a system exception occurred 1588 */ 1589 public com.liferay.portal.model.Group loadGetGroup(long companyId, 1590 java.lang.String name) 1591 throws com.liferay.portal.kernel.exception.PortalException, 1592 com.liferay.portal.kernel.exception.SystemException { 1593 return _groupLocalService.loadGetGroup(companyId, name); 1594 } 1595 1596 /** 1597 * Rebuilds the group tree. 1598 * 1599 * <p> 1600 * Only call this method if the tree has become stale through operations 1601 * other than normal CRUD. Under normal circumstances the tree is 1602 * automatically rebuilt whenever necessary. 1603 * </p> 1604 * 1605 * @param companyId the primary key of the group's company 1606 * @throws PortalException if a group with the primary key could not be 1607 found 1608 * @throws SystemException if a system exception occurred 1609 */ 1610 public void rebuildTree(long companyId) 1611 throws com.liferay.portal.kernel.exception.PortalException, 1612 com.liferay.portal.kernel.exception.SystemException { 1613 _groupLocalService.rebuildTree(companyId); 1614 } 1615 1616 /** 1617 * Returns an ordered range of all the company's groups, optionally 1618 * including the user's inherited organization groups and user groups. 1619 * System and staged groups are not included. 1620 * 1621 * <p> 1622 * Useful when paginating results. Returns a maximum of <code>end - 1623 * start</code> instances. <code>start</code> and <code>end</code> are not 1624 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1625 * refers to the first result in the set. Setting both <code>start</code> 1626 * and <code>end</code> to {@link 1627 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1628 * result set. 1629 * </p> 1630 * 1631 * @param companyId the primary key of the company 1632 * @param params the finder params (optionally <code>null</code>). To 1633 include a user's organizations, inherited organizations, and user 1634 groups in the search, add an entry with key 1635 "usersGroups" mapped to the user's ID and an entry with 1636 key "inherit" mapped to a non-<code>null</code> object. 1637 For more information see {@link 1638 com.liferay.portal.service.persistence.GroupFinder} 1639 * @param start the lower bound of the range of groups to return 1640 * @param end the upper bound of the range of groups to return (not 1641 inclusive) 1642 * @return the matching groups ordered by name 1643 * @throws SystemException if a system exception occurred 1644 */ 1645 public java.util.List<com.liferay.portal.model.Group> search( 1646 long companyId, 1647 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1648 int start, int end) 1649 throws com.liferay.portal.kernel.exception.SystemException { 1650 return _groupLocalService.search(companyId, params, start, end); 1651 } 1652 1653 /** 1654 * Returns an ordered range of all the groups belonging to the parent group 1655 * that match the keywords, optionally including the user's inherited 1656 * organization groups and user groups. System and staged groups are not 1657 * included. 1658 * 1659 * <p> 1660 * Useful when paginating results. Returns a maximum of <code>end - 1661 * start</code> instances. <code>start</code> and <code>end</code> are not 1662 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1663 * refers to the first result in the set. Setting both <code>start</code> 1664 * and <code>end</code> to {@link 1665 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1666 * result set. 1667 * </p> 1668 * 1669 * @param companyId the primary key of the company 1670 * @param parentGroupId the primary key of the parent group 1671 * @param keywords the keywords (space separated), which may occur in the 1672 sites's name, or description (optionally <code>null</code>) 1673 * @param params the finder params (optionally <code>null</code>). To 1674 include the user's inherited organizations and user groups in the 1675 search, add entries having "usersGroups" and 1676 "inherit" as keys mapped to the the user's ID. For more 1677 information see {@link 1678 com.liferay.portal.service.persistence.GroupFinder} 1679 * @param start the lower bound of the range of groups to return 1680 * @param end the upper bound of the range of groups to return (not 1681 inclusive) 1682 * @return the matching groups ordered by name 1683 * @throws SystemException if a system exception occurred 1684 */ 1685 public java.util.List<com.liferay.portal.model.Group> search( 1686 long companyId, long parentGroupId, java.lang.String keywords, 1687 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1688 int start, int end) 1689 throws com.liferay.portal.kernel.exception.SystemException { 1690 return _groupLocalService.search(companyId, parentGroupId, keywords, 1691 params, start, end); 1692 } 1693 1694 /** 1695 * Returns an ordered range of all the groups belonging to the parent group 1696 * that match the keywords, optionally including the user's inherited 1697 * organization groups and user groups. System and staged groups are not 1698 * included. 1699 * 1700 * <p> 1701 * Useful when paginating results. Returns a maximum of <code>end - 1702 * start</code> instances. <code>start</code> and <code>end</code> are not 1703 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1704 * refers to the first result in the set. Setting both <code>start</code> 1705 * and <code>end</code> to {@link 1706 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1707 * result set. 1708 * </p> 1709 * 1710 * @param companyId the primary key of the company 1711 * @param parentGroupId the primary key of the parent group 1712 * @param keywords the keywords (space separated), which may occur in the 1713 sites's name, or description (optionally <code>null</code>) 1714 * @param params the finder params (optionally <code>null</code>). To 1715 include the user's inherited organizations and user groups in the 1716 search, add entries having "usersGroups" and 1717 "inherit" as keys mapped to the the user's ID. For more 1718 information see {@link 1719 com.liferay.portal.service.persistence.GroupFinder} 1720 * @param start the lower bound of the range of groups to return 1721 * @param end the upper bound of the range of groups to return (not 1722 inclusive) 1723 * @param obc the comparator to order the groups (optionally 1724 <code>null</code>) 1725 * @return the matching groups ordered by comparator <code>obc</code> 1726 * @throws SystemException if a system exception occurred 1727 */ 1728 public java.util.List<com.liferay.portal.model.Group> search( 1729 long companyId, long parentGroupId, java.lang.String keywords, 1730 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1731 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1732 throws com.liferay.portal.kernel.exception.SystemException { 1733 return _groupLocalService.search(companyId, parentGroupId, keywords, 1734 params, start, end, obc); 1735 } 1736 1737 /** 1738 * Returns an ordered range of all the site groups belonging to the parent 1739 * group and organization groups that match the name and description, 1740 * optionally including the user's inherited organization groups and user 1741 * groups. System and staged groups are not included. 1742 * 1743 * <p> 1744 * Useful when paginating results. Returns a maximum of <code>end - 1745 * start</code> instances. <code>start</code> and <code>end</code> are not 1746 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1747 * refers to the first result in the set. Setting both <code>start</code> 1748 * and <code>end</code> to {@link 1749 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1750 * result set. 1751 * </p> 1752 * 1753 * @param companyId the primary key of the company 1754 * @param parentGroupId the primary key of the parent group 1755 * @param name the group's name (optionally <code>null</code>) 1756 * @param description the group's description (optionally 1757 <code>null</code>) 1758 * @param params the finder params (optionally <code>null</code>). To 1759 include the user's inherited organizations and user groups in the 1760 search, add entries having "usersGroups" and 1761 "inherit" as keys mapped to the the user's ID. For more 1762 information see {@link 1763 com.liferay.portal.service.persistence.GroupFinder} 1764 * @param andOperator whether every field must match its keywords, or just 1765 one field. 1766 * @param start the lower bound of the range of groups to return 1767 * @param end the upper bound of the range of groups to return (not 1768 inclusive) 1769 * @return the matching groups ordered by name 1770 * @throws SystemException if a system exception occurred 1771 */ 1772 public java.util.List<com.liferay.portal.model.Group> search( 1773 long companyId, long parentGroupId, java.lang.String name, 1774 java.lang.String description, 1775 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1776 boolean andOperator, int start, int end) 1777 throws com.liferay.portal.kernel.exception.SystemException { 1778 return _groupLocalService.search(companyId, parentGroupId, name, 1779 description, params, andOperator, start, end); 1780 } 1781 1782 /** 1783 * Returns an ordered range of all the site groups belonging to the parent 1784 * group and organization groups that match the name and description, 1785 * optionally including the user's inherited organization groups and user 1786 * groups. System and staged groups are not included. 1787 * 1788 * <p> 1789 * Useful when paginating results. Returns a maximum of <code>end - 1790 * start</code> instances. <code>start</code> and <code>end</code> are not 1791 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1792 * refers to the first result in the set. Setting both <code>start</code> 1793 * and <code>end</code> to {@link 1794 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1795 * result set. 1796 * </p> 1797 * 1798 * @param companyId the primary key of the company 1799 * @param parentGroupId the primary key of the parent group 1800 * @param name the group's name (optionally <code>null</code>) 1801 * @param description the group's description (optionally 1802 <code>null</code>) 1803 * @param params the finder params (optionally <code>null</code>). To 1804 include the user's inherited organizations and user groups in the 1805 search, add entries having "usersGroups" and 1806 "inherit" as keys mapped to the the user's ID. For more 1807 information see {@link 1808 com.liferay.portal.service.persistence.GroupFinder} 1809 * @param andOperator whether every field must match its keywords, or just 1810 one field. 1811 * @param start the lower bound of the range of groups to return 1812 * @param end the upper bound of the range of groups to return (not 1813 inclusive) 1814 * @param obc the comparator to order the groups (optionally 1815 <code>null</code>) 1816 * @return the matching groups ordered by comparator <code>obc</code> 1817 * @throws SystemException if a system exception occurred 1818 */ 1819 public java.util.List<com.liferay.portal.model.Group> search( 1820 long companyId, long parentGroupId, java.lang.String name, 1821 java.lang.String description, 1822 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1823 boolean andOperator, int start, int end, 1824 com.liferay.portal.kernel.util.OrderByComparator obc) 1825 throws com.liferay.portal.kernel.exception.SystemException { 1826 return _groupLocalService.search(companyId, parentGroupId, name, 1827 description, params, andOperator, start, end, obc); 1828 } 1829 1830 /** 1831 * Returns an ordered range of all the groups belonging to the parent group 1832 * that match the class name IDs and keywords, optionally including the 1833 * user's inherited organization groups and user groups. System and staged 1834 * groups are not included. 1835 * 1836 * <p> 1837 * Useful when paginating results. Returns a maximum of <code>end - 1838 * start</code> instances. <code>start</code> and <code>end</code> are not 1839 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1840 * refers to the first result in the set. Setting both <code>start</code> 1841 * and <code>end</code> to {@link 1842 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1843 * result set. 1844 * </p> 1845 * 1846 * @param companyId the primary key of the company 1847 * @param classNameIds the primary keys of the class names of the entities 1848 the groups are related to (optionally <code>null</code>) 1849 * @param parentGroupId the primary key of the parent group 1850 * @param keywords the keywords (space separated), which may occur in the 1851 sites's name, or description (optionally <code>null</code>) 1852 * @param params the finder params (optionally <code>null</code>). To 1853 include a user's organizations, inherited organizations, and user 1854 groups in the search, add an entry with key 1855 "usersGroups" mapped to the user's ID and an entry with 1856 key "inherit" mapped to a non-<code>null</code> object. 1857 For more information see {@link 1858 com.liferay.portal.service.persistence.GroupFinder} 1859 * @param start the lower bound of the range of groups to return 1860 * @param end the upper bound of the range of groups to return (not 1861 inclusive) 1862 * @return the matching groups ordered by name 1863 * @throws SystemException if a system exception occurred 1864 */ 1865 public java.util.List<com.liferay.portal.model.Group> search( 1866 long companyId, long[] classNameIds, long parentGroupId, 1867 java.lang.String keywords, 1868 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1869 int start, int end) 1870 throws com.liferay.portal.kernel.exception.SystemException { 1871 return _groupLocalService.search(companyId, classNameIds, 1872 parentGroupId, keywords, params, start, end); 1873 } 1874 1875 /** 1876 * Returns an ordered range of all the groups belonging to the parent group 1877 * that match the class name IDs and keywords, optionally including the 1878 * user's inherited organization groups and user groups. System and staged 1879 * groups are not included. 1880 * 1881 * <p> 1882 * Useful when paginating results. Returns a maximum of <code>end - 1883 * start</code> instances. <code>start</code> and <code>end</code> are not 1884 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1885 * refers to the first result in the set. Setting both <code>start</code> 1886 * and <code>end</code> to {@link 1887 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1888 * result set. 1889 * </p> 1890 * 1891 * @param companyId the primary key of the company 1892 * @param classNameIds the primary keys of the class names of the entities 1893 the groups are related to (optionally <code>null</code>) 1894 * @param parentGroupId the primary key of the parent group 1895 * @param keywords the keywords (space separated), which may occur in the 1896 sites's name, or description (optionally <code>null</code>) 1897 * @param params the finder params (optionally <code>null</code>). To 1898 include a user's organizations, inherited organizations, and user 1899 groups in the search, add an entry with key 1900 "usersGroups" mapped to the user's ID and an entry with 1901 key "inherit" mapped to a non-<code>null</code> object. 1902 For more information see {@link 1903 com.liferay.portal.service.persistence.GroupFinder} 1904 * @param start the lower bound of the range of groups to return 1905 * @param end the upper bound of the range of groups to return (not 1906 inclusive) 1907 * @param obc the comparator to order the groups (optionally 1908 <code>null</code>) 1909 * @return the matching groups ordered by comparator <code>obc</code> 1910 * @throws SystemException if a system exception occurred 1911 */ 1912 public java.util.List<com.liferay.portal.model.Group> search( 1913 long companyId, long[] classNameIds, long parentGroupId, 1914 java.lang.String keywords, 1915 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1916 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1917 throws com.liferay.portal.kernel.exception.SystemException { 1918 return _groupLocalService.search(companyId, classNameIds, 1919 parentGroupId, keywords, params, start, end, obc); 1920 } 1921 1922 /** 1923 * Returns an ordered range of all the groups belonging to the parent group 1924 * that match the class name IDs, name, and description, optionally 1925 * including the user's inherited organization groups and user groups. 1926 * System and staged groups are not included. 1927 * 1928 * <p> 1929 * Useful when paginating results. Returns a maximum of <code>end - 1930 * start</code> instances. <code>start</code> and <code>end</code> are not 1931 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1932 * refers to the first result in the set. Setting both <code>start</code> 1933 * and <code>end</code> to {@link 1934 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1935 * result set. 1936 * </p> 1937 * 1938 * @param companyId the primary key of the company 1939 * @param classNameIds the primary keys of the class names of the entities 1940 the groups are related to (optionally <code>null</code>) 1941 * @param parentGroupId the primary key of the parent group 1942 * @param name the group's name (optionally <code>null</code>) 1943 * @param description the group's description (optionally 1944 <code>null</code>) 1945 * @param params the finder params (optionally <code>null</code>). To 1946 include a user's organizations, inherited organizations, and user 1947 groups in the search, add an entry with key 1948 "usersGroups" mapped to the user's ID and an entry with 1949 key "inherit" mapped to a non-<code>null</code> object. 1950 For more information see {@link 1951 com.liferay.portal.service.persistence.GroupFinder} 1952 * @param andOperator whether every field must match its keywords, or just 1953 one field. 1954 * @param start the lower bound of the range of groups to return 1955 * @param end the upper bound of the range of groups to return (not 1956 inclusive) 1957 * @return the matching groups ordered by name 1958 * @throws SystemException if a system exception occurred 1959 */ 1960 public java.util.List<com.liferay.portal.model.Group> search( 1961 long companyId, long[] classNameIds, long parentGroupId, 1962 java.lang.String name, java.lang.String description, 1963 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 1964 boolean andOperator, int start, int end) 1965 throws com.liferay.portal.kernel.exception.SystemException { 1966 return _groupLocalService.search(companyId, classNameIds, 1967 parentGroupId, name, description, params, andOperator, start, end); 1968 } 1969 1970 /** 1971 * Returns an ordered range of all the groups belonging to the parent group 1972 * that match the class name IDs, name, and description, optionally 1973 * including the user's inherited organization groups and user groups. 1974 * System and staged groups are not included. 1975 * 1976 * <p> 1977 * Useful when paginating results. Returns a maximum of <code>end - 1978 * start</code> instances. <code>start</code> and <code>end</code> are not 1979 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1980 * refers to the first result in the set. Setting both <code>start</code> 1981 * and <code>end</code> to {@link 1982 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1983 * result set. 1984 * </p> 1985 * 1986 * @param companyId the primary key of the company 1987 * @param classNameIds the primary keys of the class names of the entities 1988 the groups are related to (optionally <code>null</code>) 1989 * @param parentGroupId the primary key of the parent group 1990 * @param name the group's name (optionally <code>null</code>) 1991 * @param description the group's description (optionally 1992 <code>null</code>) 1993 * @param params the finder params (optionally <code>null</code>). To 1994 include a user's organizations, inherited organizations, and user 1995 groups in the search, add an entry with key 1996 "usersGroups" mapped to the user's ID and an entry with 1997 key "inherit" mapped to a non-<code>null</code> object. 1998 For more information see {@link 1999 com.liferay.portal.service.persistence.GroupFinder} 2000 * @param andOperator whether every field must match its keywords, or just 2001 one field. 2002 * @param start the lower bound of the range of groups to return 2003 * @param end the upper bound of the range of groups to return (not 2004 inclusive) 2005 * @param obc the comparator to order the groups (optionally 2006 <code>null</code>) 2007 * @return the matching groups ordered by comparator <code>obc</code> 2008 * @throws SystemException if a system exception occurred 2009 */ 2010 public java.util.List<com.liferay.portal.model.Group> search( 2011 long companyId, long[] classNameIds, long parentGroupId, 2012 java.lang.String name, java.lang.String description, 2013 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2014 boolean andOperator, int start, int end, 2015 com.liferay.portal.kernel.util.OrderByComparator obc) 2016 throws com.liferay.portal.kernel.exception.SystemException { 2017 return _groupLocalService.search(companyId, classNameIds, 2018 parentGroupId, name, description, params, andOperator, start, end, 2019 obc); 2020 } 2021 2022 /** 2023 * Returns an ordered range of all the groups that match the class name IDs 2024 * and keywords, optionally including the user's inherited organization 2025 * groups and user groups. System and staged groups are not included. 2026 * 2027 * <p> 2028 * Useful when paginating results. Returns a maximum of <code>end - 2029 * start</code> instances. <code>start</code> and <code>end</code> are not 2030 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2031 * refers to the first result in the set. Setting both <code>start</code> 2032 * and <code>end</code> to {@link 2033 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2034 * result set. 2035 * </p> 2036 * 2037 * @param companyId the primary key of the company 2038 * @param classNameIds the primary keys of the class names of the entities 2039 the groups are related to (optionally <code>null</code>) 2040 * @param keywords the keywords (space separated), which may occur in the 2041 sites's name, or description (optionally <code>null</code>) 2042 * @param params the finder params (optionally <code>null</code>). To 2043 include a user's organizations, inherited organizations, and user 2044 groups in the search, add an entry with key 2045 "usersGroups" mapped to the user's ID and an entry with 2046 key "inherit" mapped to a non-<code>null</code> object. 2047 For more information see {@link 2048 com.liferay.portal.service.persistence.GroupFinder} 2049 * @param start the lower bound of the range of groups to return 2050 * @param end the upper bound of the range of groups to return (not 2051 inclusive) 2052 * @return the matching groups ordered by name 2053 * @throws SystemException if a system exception occurred 2054 */ 2055 public java.util.List<com.liferay.portal.model.Group> search( 2056 long companyId, long[] classNameIds, java.lang.String keywords, 2057 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2058 int start, int end) 2059 throws com.liferay.portal.kernel.exception.SystemException { 2060 return _groupLocalService.search(companyId, classNameIds, keywords, 2061 params, start, end); 2062 } 2063 2064 /** 2065 * Returns an ordered range of all the groups that match the class name IDs 2066 * and keywords, optionally including the user's inherited organization 2067 * groups and user groups. System and staged groups are not included. 2068 * 2069 * <p> 2070 * Useful when paginating results. Returns a maximum of <code>end - 2071 * start</code> instances. <code>start</code> and <code>end</code> are not 2072 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2073 * refers to the first result in the set. Setting both <code>start</code> 2074 * and <code>end</code> to {@link 2075 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2076 * result set. 2077 * </p> 2078 * 2079 * @param companyId the primary key of the company 2080 * @param classNameIds the primary keys of the class names of the entities 2081 the groups are related to (optionally <code>null</code>) 2082 * @param keywords the keywords (space separated), which may occur in the 2083 sites's name, or description (optionally <code>null</code>) 2084 * @param params the finder params (optionally <code>null</code>). To 2085 include a user's organizations, inherited organizations, and user 2086 groups in the search, add an entry with key 2087 "usersGroups" mapped to the user's ID and an entry with 2088 key "inherit" mapped to a non-<code>null</code> object. 2089 For more information see {@link 2090 com.liferay.portal.service.persistence.GroupFinder} 2091 * @param start the lower bound of the range of groups to return 2092 * @param end the upper bound of the range of groups to return (not 2093 inclusive) 2094 * @param obc the comparator to order the groups (optionally 2095 <code>null</code>) 2096 * @return the matching groups ordered by comparator <code>obc</code> 2097 * @throws SystemException if a system exception occurred 2098 */ 2099 public java.util.List<com.liferay.portal.model.Group> search( 2100 long companyId, long[] classNameIds, java.lang.String keywords, 2101 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2102 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 2103 throws com.liferay.portal.kernel.exception.SystemException { 2104 return _groupLocalService.search(companyId, classNameIds, keywords, 2105 params, start, end, obc); 2106 } 2107 2108 /** 2109 * Returns an ordered range of all the groups that match the class name IDs, 2110 * name, and description, optionally including the user's inherited 2111 * organization groups and user groups. System and staged groups are not 2112 * included. 2113 * 2114 * <p> 2115 * Useful when paginating results. Returns a maximum of <code>end - 2116 * start</code> instances. <code>start</code> and <code>end</code> are not 2117 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2118 * refers to the first result in the set. Setting both <code>start</code> 2119 * and <code>end</code> to {@link 2120 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2121 * result set. 2122 * </p> 2123 * 2124 * @param companyId the primary key of the company 2125 * @param classNameIds the primary keys of the class names of the entities 2126 the groups are related to (optionally <code>null</code>) 2127 * @param name the group's name (optionally <code>null</code>) 2128 * @param description the group's description (optionally 2129 <code>null</code>) 2130 * @param params the finder params (optionally <code>null</code>). To 2131 include a user's organizations, inherited organizations, and user 2132 groups in the search, add an entry with key 2133 "usersGroups" mapped to the user's ID and an entry with 2134 key "inherit" mapped to a non-<code>null</code> object. 2135 For more information see {@link 2136 com.liferay.portal.service.persistence.GroupFinder} 2137 * @param andOperator whether every field must match its keywords, or just 2138 one field. 2139 * @param start the lower bound of the range of groups to return 2140 * @param end the upper bound of the range of groups to return (not 2141 inclusive) 2142 * @return the matching groups ordered by name 2143 * @throws SystemException if a system exception occurred 2144 */ 2145 public java.util.List<com.liferay.portal.model.Group> search( 2146 long companyId, long[] classNameIds, java.lang.String name, 2147 java.lang.String description, 2148 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2149 boolean andOperator, int start, int end) 2150 throws com.liferay.portal.kernel.exception.SystemException { 2151 return _groupLocalService.search(companyId, classNameIds, name, 2152 description, params, andOperator, start, end); 2153 } 2154 2155 /** 2156 * Returns an ordered range of all the groups that match the class name IDs, 2157 * name, and description, optionally including the user's inherited 2158 * organization groups and user groups. System and staged groups are not 2159 * included. 2160 * 2161 * <p> 2162 * Useful when paginating results. Returns a maximum of <code>end - 2163 * start</code> instances. <code>start</code> and <code>end</code> are not 2164 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2165 * refers to the first result in the set. Setting both <code>start</code> 2166 * and <code>end</code> to {@link 2167 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2168 * result set. 2169 * </p> 2170 * 2171 * @param companyId the primary key of the company 2172 * @param classNameIds the primary keys of the class names of the entities 2173 the groups are related to (optionally <code>null</code>) 2174 * @param name the group's name (optionally <code>null</code>) 2175 * @param description the group's description (optionally 2176 <code>null</code>) 2177 * @param params the finder params (optionally <code>null</code>). To 2178 include a user's organizations, inherited organizations, and user 2179 groups in the search, add an entry with key 2180 "usersGroups" mapped to the user's ID and an entry with 2181 key "inherit" mapped to a non-<code>null</code> object. 2182 For more information see {@link 2183 com.liferay.portal.service.persistence.GroupFinder} 2184 * @param andOperator whether every field must match its keywords, or just 2185 one field. 2186 * @param start the lower bound of the range of groups to return 2187 * @param end the upper bound of the range of groups to return (not 2188 inclusive) 2189 * @param obc the comparator to order the groups (optionally 2190 <code>null</code>) 2191 * @return the matching groups ordered by comparator <code>obc</code> 2192 * @throws SystemException if a system exception occurred 2193 */ 2194 public java.util.List<com.liferay.portal.model.Group> search( 2195 long companyId, long[] classNameIds, java.lang.String name, 2196 java.lang.String description, 2197 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2198 boolean andOperator, int start, int end, 2199 com.liferay.portal.kernel.util.OrderByComparator obc) 2200 throws com.liferay.portal.kernel.exception.SystemException { 2201 return _groupLocalService.search(companyId, classNameIds, name, 2202 description, params, andOperator, start, end, obc); 2203 } 2204 2205 /** 2206 * Returns an ordered range of all the groups that match the keywords, 2207 * optionally including the user's inherited organization groups and user 2208 * groups. System and staged groups are not included. 2209 * 2210 * <p> 2211 * Useful when paginating results. Returns a maximum of <code>end - 2212 * start</code> instances. <code>start</code> and <code>end</code> are not 2213 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2214 * refers to the first result in the set. Setting both <code>start</code> 2215 * and <code>end</code> to {@link 2216 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2217 * result set. 2218 * </p> 2219 * 2220 * @param companyId the primary key of the company 2221 * @param keywords the keywords (space separated), which may occur in the 2222 sites's name, or description (optionally <code>null</code>) 2223 * @param params the finder params (optionally <code>null</code>). To 2224 include the user's inherited organizations and user groups in the 2225 search, add entries having "usersGroups" and 2226 "inherit" as keys mapped to the the user's ID. For more 2227 information see {@link 2228 com.liferay.portal.service.persistence.GroupFinder} 2229 * @param start the lower bound of the range of groups to return 2230 * @param end the upper bound of the range of groups to return (not 2231 inclusive) 2232 * @return the matching groups ordered by name 2233 * @throws SystemException if a system exception occurred 2234 */ 2235 public java.util.List<com.liferay.portal.model.Group> search( 2236 long companyId, java.lang.String keywords, 2237 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2238 int start, int end) 2239 throws com.liferay.portal.kernel.exception.SystemException { 2240 return _groupLocalService.search(companyId, keywords, params, start, end); 2241 } 2242 2243 /** 2244 * Returns an ordered range of all the groups that match the keywords, 2245 * optionally including the user's inherited organization groups and user 2246 * groups. System and staged groups are not included. 2247 * 2248 * <p> 2249 * Useful when paginating results. Returns a maximum of <code>end - 2250 * start</code> instances. <code>start</code> and <code>end</code> are not 2251 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2252 * refers to the first result in the set. Setting both <code>start</code> 2253 * and <code>end</code> to {@link 2254 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2255 * result set. 2256 * </p> 2257 * 2258 * @param companyId the primary key of the company 2259 * @param keywords the keywords (space separated), which may occur in the 2260 sites's name, or description (optionally <code>null</code>) 2261 * @param params the finder params (optionally <code>null</code>). To 2262 include the user's inherited organizations and user groups in the 2263 search, add entries having "usersGroups" and 2264 "inherit" as keys mapped to the the user's ID. For more 2265 information see {@link 2266 com.liferay.portal.service.persistence.GroupFinder} 2267 * @param start the lower bound of the range of groups to return 2268 * @param end the upper bound of the range of groups to return (not 2269 inclusive) 2270 * @param obc the comparator to order the groups (optionally 2271 <code>null</code>) 2272 * @return the matching groups ordered by comparator <code>obc</code> 2273 * @throws SystemException if a system exception occurred 2274 */ 2275 public java.util.List<com.liferay.portal.model.Group> search( 2276 long companyId, java.lang.String keywords, 2277 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2278 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 2279 throws com.liferay.portal.kernel.exception.SystemException { 2280 return _groupLocalService.search(companyId, keywords, params, start, 2281 end, obc); 2282 } 2283 2284 /** 2285 * Returns an ordered range of all the site groups and organization groups 2286 * that match the name and description, optionally including the user's 2287 * inherited organization groups and user groups. System and staged groups 2288 * are not included. 2289 * 2290 * <p> 2291 * Useful when paginating results. Returns a maximum of <code>end - 2292 * start</code> instances. <code>start</code> and <code>end</code> are not 2293 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2294 * refers to the first result in the set. Setting both <code>start</code> 2295 * and <code>end</code> to {@link 2296 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2297 * result set. 2298 * </p> 2299 * 2300 * @param companyId the primary key of the company 2301 * @param name the group's name (optionally <code>null</code>) 2302 * @param description the group's description (optionally 2303 <code>null</code>) 2304 * @param params the finder params (optionally <code>null</code>). To 2305 include the user's inherited organizations and user groups in the 2306 search, add entries having "usersGroups" and 2307 "inherit" as keys mapped to the the user's ID. For more 2308 information see {@link 2309 com.liferay.portal.service.persistence.GroupFinder} 2310 * @param andOperator whether every field must match its keywords, or just 2311 one field. 2312 * @param start the lower bound of the range of groups to return 2313 * @param end the upper bound of the range of groups to return (not 2314 inclusive) 2315 * @return the matching groups ordered by name 2316 * @throws SystemException if a system exception occurred 2317 */ 2318 public java.util.List<com.liferay.portal.model.Group> search( 2319 long companyId, java.lang.String name, java.lang.String description, 2320 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2321 boolean andOperator, int start, int end) 2322 throws com.liferay.portal.kernel.exception.SystemException { 2323 return _groupLocalService.search(companyId, name, description, params, 2324 andOperator, start, end); 2325 } 2326 2327 /** 2328 * Returns an ordered range of all the site groups and organization groups 2329 * that match the name and description, optionally including the user's 2330 * inherited organization groups and user groups. System and staged groups 2331 * are not included. 2332 * 2333 * <p> 2334 * Useful when paginating results. Returns a maximum of <code>end - 2335 * start</code> instances. <code>start</code> and <code>end</code> are not 2336 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2337 * refers to the first result in the set. Setting both <code>start</code> 2338 * and <code>end</code> to {@link 2339 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2340 * result set. 2341 * </p> 2342 * 2343 * @param companyId the primary key of the company 2344 * @param name the group's name (optionally <code>null</code>) 2345 * @param description the group's description (optionally 2346 <code>null</code>) 2347 * @param params the finder params (optionally <code>null</code>). To 2348 include the user's inherited organizations and user groups in the 2349 search, add entries having "usersGroups" and 2350 "inherit" as keys mapped to the the user's ID. For more 2351 information see {@link 2352 com.liferay.portal.service.persistence.GroupFinder} 2353 * @param andOperator whether every field must match its keywords, or just 2354 one field. 2355 * @param start the lower bound of the range of groups to return 2356 * @param end the upper bound of the range of groups to return (not 2357 inclusive) 2358 * @param obc the comparator to order the groups (optionally 2359 <code>null</code>) 2360 * @return the matching groups ordered by comparator <code>obc</code> 2361 * @throws SystemException if a system exception occurred 2362 */ 2363 public java.util.List<com.liferay.portal.model.Group> search( 2364 long companyId, java.lang.String name, java.lang.String description, 2365 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2366 boolean andOperator, int start, int end, 2367 com.liferay.portal.kernel.util.OrderByComparator obc) 2368 throws com.liferay.portal.kernel.exception.SystemException { 2369 return _groupLocalService.search(companyId, name, description, params, 2370 andOperator, start, end, obc); 2371 } 2372 2373 /** 2374 * Returns the number of groups belonging to the parent group that match the 2375 * keywords, optionally including the user's inherited organization groups 2376 * and user groups. System and staged groups are not included. 2377 * 2378 * @param companyId the primary key of the company 2379 * @param parentGroupId the primary key of the parent group 2380 * @param keywords the keywords (space separated), which may occur in the 2381 sites's name, or description (optionally <code>null</code>) 2382 * @param params the finder params (optionally <code>null</code>). To 2383 include the user's inherited organization groups and user groups 2384 in the search, add entries having "usersGroups" and 2385 "inherit" as keys mapped to the the user's ID. For more 2386 information see {@link 2387 com.liferay.portal.service.persistence.GroupFinder} 2388 * @return the number of matching groups 2389 * @throws SystemException if a system exception occurred 2390 */ 2391 public int searchCount(long companyId, long parentGroupId, 2392 java.lang.String keywords, 2393 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2394 throws com.liferay.portal.kernel.exception.SystemException { 2395 return _groupLocalService.searchCount(companyId, parentGroupId, 2396 keywords, params); 2397 } 2398 2399 /** 2400 * Returns the number of groups belonging to the parent group and immediate 2401 * organization groups that match the name and description, optionally 2402 * including the user's inherited organization groups and user groups. 2403 * System and staged groups are not included. 2404 * 2405 * @param companyId the primary key of the company 2406 * @param parentGroupId the primary key of the parent group 2407 * @param name the group's name (optionally <code>null</code>) 2408 * @param description the group's description (optionally 2409 <code>null</code>) 2410 * @param params the finder params (optionally <code>null</code>). To 2411 include the user's inherited organization groups and user groups 2412 in the search, add entries having "usersGroups" and 2413 "inherit" as keys mapped to the the user's ID. For more 2414 information see {@link 2415 com.liferay.portal.service.persistence.GroupFinder} 2416 * @param andOperator whether every field must match its keywords, or just 2417 one field. 2418 * @return the number of matching groups 2419 * @throws SystemException if a system exception occurred 2420 */ 2421 public int searchCount(long companyId, long parentGroupId, 2422 java.lang.String name, java.lang.String description, 2423 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2424 boolean andOperator) 2425 throws com.liferay.portal.kernel.exception.SystemException { 2426 return _groupLocalService.searchCount(companyId, parentGroupId, name, 2427 description, params, andOperator); 2428 } 2429 2430 /** 2431 * Returns the number of groups belonging to the parent group that match the 2432 * class name IDs, and keywords, optionally including the user's inherited 2433 * organization groups and user groups. System and staged groups are not 2434 * included. 2435 * 2436 * @param companyId the primary key of the company 2437 * @param classNameIds the primary keys of the class names of the entities 2438 the groups are related to (optionally <code>null</code>) 2439 * @param parentGroupId the primary key of the parent group 2440 * @param keywords the keywords (space separated), which may occur in the 2441 sites's name, or description (optionally <code>null</code>) 2442 * @param params the finder params (optionally <code>null</code>). To 2443 include the user's inherited organization groups and user groups 2444 in the search, add entries having "usersGroups" and 2445 "inherit" as keys mapped to the the user's ID. For more 2446 information see {@link 2447 com.liferay.portal.service.persistence.GroupFinder} 2448 * @return the number of matching groups 2449 * @throws SystemException if a system exception occurred 2450 */ 2451 public int searchCount(long companyId, long[] classNameIds, 2452 long parentGroupId, java.lang.String keywords, 2453 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2454 throws com.liferay.portal.kernel.exception.SystemException { 2455 return _groupLocalService.searchCount(companyId, classNameIds, 2456 parentGroupId, keywords, params); 2457 } 2458 2459 /** 2460 * Returns the number of groups belonging to the parent group that match the 2461 * class name IDs, name, and description, optionally including the user's 2462 * inherited organization groups and user groups. System and staged groups 2463 * are not included. 2464 * 2465 * @param companyId the primary key of the company 2466 * @param classNameIds the primary keys of the class names of the entities 2467 the groups are related to (optionally <code>null</code>) 2468 * @param parentGroupId the primary key of the parent group 2469 * @param name the group's name (optionally <code>null</code>) 2470 * @param description the group's description (optionally 2471 <code>null</code>) 2472 * @param params the finder params (optionally <code>null</code>). To 2473 include the user's inherited organization groups and user groups 2474 in the search, add entries having "usersGroups" and 2475 "inherit" as keys mapped to the the user's ID. For more 2476 information see {@link 2477 com.liferay.portal.service.persistence.GroupFinder} 2478 * @param andOperator whether every field must match its keywords, or just 2479 one field. 2480 * @return the number of matching groups 2481 * @throws SystemException if a system exception occurred 2482 */ 2483 public int searchCount(long companyId, long[] classNameIds, 2484 long parentGroupId, java.lang.String name, 2485 java.lang.String description, 2486 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2487 boolean andOperator) 2488 throws com.liferay.portal.kernel.exception.SystemException { 2489 return _groupLocalService.searchCount(companyId, classNameIds, 2490 parentGroupId, name, description, params, andOperator); 2491 } 2492 2493 /** 2494 * Returns the number of groups that match the class name IDs, and keywords, 2495 * optionally including the user's inherited organization groups and user 2496 * groups. System and staged groups are not included. 2497 * 2498 * @param companyId the primary key of the company 2499 * @param classNameIds the primary keys of the class names of the entities 2500 the groups are related to (optionally <code>null</code>) 2501 * @param keywords the keywords (space separated), which may occur in the 2502 sites's name, or description (optionally <code>null</code>) 2503 * @param params the finder params (optionally <code>null</code>). To 2504 include the user's inherited organization groups and user groups 2505 in the search, add entries having "usersGroups" and 2506 "inherit" as keys mapped to the the user's ID. For more 2507 information see {@link 2508 com.liferay.portal.service.persistence.GroupFinder} 2509 * @return the number of matching groups 2510 * @throws SystemException if a system exception occurred 2511 */ 2512 public int searchCount(long companyId, long[] classNameIds, 2513 java.lang.String keywords, 2514 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2515 throws com.liferay.portal.kernel.exception.SystemException { 2516 return _groupLocalService.searchCount(companyId, classNameIds, 2517 keywords, params); 2518 } 2519 2520 /** 2521 * Returns the number of groups that match the class name IDs, name, and 2522 * description, optionally including the user's inherited organization 2523 * groups and user groups. System and staged groups are not included. 2524 * 2525 * @param companyId the primary key of the company 2526 * @param classNameIds the primary keys of the class names of the entities 2527 the groups are related to (optionally <code>null</code>) 2528 * @param name the group's name (optionally <code>null</code>) 2529 * @param description the group's description (optionally 2530 <code>null</code>) 2531 * @param params the finder params (optionally <code>null</code>). To 2532 include the user's inherited organization groups and user groups 2533 in the search, add entries having "usersGroups" and 2534 "inherit" as keys mapped to the the user's ID. For more 2535 information see {@link 2536 com.liferay.portal.service.persistence.GroupFinder} 2537 * @param andOperator whether every field must match its keywords, or just 2538 one field. 2539 * @return the number of matching groups 2540 * @throws SystemException if a system exception occurred 2541 */ 2542 public int searchCount(long companyId, long[] classNameIds, 2543 java.lang.String name, java.lang.String description, 2544 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2545 boolean andOperator) 2546 throws com.liferay.portal.kernel.exception.SystemException { 2547 return _groupLocalService.searchCount(companyId, classNameIds, name, 2548 description, params, andOperator); 2549 } 2550 2551 /** 2552 * Returns the number of groups that match the keywords, optionally 2553 * including the user's inherited organization groups and user groups. 2554 * System and staged groups are not included. 2555 * 2556 * @param companyId the primary key of the company 2557 * @param keywords the keywords (space separated), which may occur in the 2558 sites's name, or description (optionally <code>null</code>) 2559 * @param params the finder params (optionally <code>null</code>). To 2560 include the user's inherited organization groups and user groups 2561 in the search, add entries having "usersGroups" and 2562 "inherit" as keys mapped to the the user's ID. For more 2563 information see {@link 2564 com.liferay.portal.service.persistence.GroupFinder} 2565 * @return the number of matching groups 2566 * @throws SystemException if a system exception occurred 2567 */ 2568 public int searchCount(long companyId, java.lang.String keywords, 2569 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2570 throws com.liferay.portal.kernel.exception.SystemException { 2571 return _groupLocalService.searchCount(companyId, keywords, params); 2572 } 2573 2574 /** 2575 * Returns the number of groups and immediate organization groups that match 2576 * the name and description, optionally including the user's inherited 2577 * organization groups and user groups. System and staged groups are not 2578 * included. 2579 * 2580 * @param companyId the primary key of the company 2581 * @param name the group's name (optionally <code>null</code>) 2582 * @param description the group's description (optionally 2583 <code>null</code>) 2584 * @param params the finder params (optionally <code>null</code>). To 2585 include the user's inherited organization groups and user groups 2586 in the search, add entries having "usersGroups" and 2587 "inherit" as keys mapped to the the user's ID. For more 2588 information see {@link 2589 com.liferay.portal.service.persistence.GroupFinder} 2590 * @param andOperator whether every field must match its keywords, or just 2591 one field. 2592 * @return the number of matching groups 2593 * @throws SystemException if a system exception occurred 2594 */ 2595 public int searchCount(long companyId, java.lang.String name, 2596 java.lang.String description, 2597 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2598 boolean andOperator) 2599 throws com.liferay.portal.kernel.exception.SystemException { 2600 return _groupLocalService.searchCount(companyId, name, description, 2601 params, andOperator); 2602 } 2603 2604 /** 2605 * Removes the groups from the role. 2606 * 2607 * @param roleId the primary key of the role 2608 * @param groupIds the primary keys of the groups 2609 * @throws SystemException if a system exception occurred 2610 */ 2611 public void unsetRoleGroups(long roleId, long[] groupIds) 2612 throws com.liferay.portal.kernel.exception.SystemException { 2613 _groupLocalService.unsetRoleGroups(roleId, groupIds); 2614 } 2615 2616 /** 2617 * Removes the user from the groups. 2618 * 2619 * @param userId the primary key of the user 2620 * @param groupIds the primary keys of the groups 2621 * @throws SystemException if a system exception occurred 2622 */ 2623 public void unsetUserGroups(long userId, long[] groupIds) 2624 throws com.liferay.portal.kernel.exception.SystemException { 2625 _groupLocalService.unsetUserGroups(userId, groupIds); 2626 } 2627 2628 /** 2629 * Updates the group's asset replacing categories and tag names. 2630 * 2631 * @param userId the primary key of the user 2632 * @param group the group 2633 * @param assetCategoryIds the primary keys of the asset categories 2634 (optionally <code>null</code>) 2635 * @param assetTagNames the asset tag names (optionally <code>null</code>) 2636 * @throws PortalException if a user with the primary key could not be found 2637 * @throws SystemException if a system exception occurred 2638 */ 2639 public void updateAsset(long userId, com.liferay.portal.model.Group group, 2640 long[] assetCategoryIds, java.lang.String[] assetTagNames) 2641 throws com.liferay.portal.kernel.exception.PortalException, 2642 com.liferay.portal.kernel.exception.SystemException { 2643 _groupLocalService.updateAsset(userId, group, assetCategoryIds, 2644 assetTagNames); 2645 } 2646 2647 /** 2648 * Updates the group's friendly URL. 2649 * 2650 * @param groupId the primary key of the group 2651 * @param friendlyURL the group's new friendlyURL (optionally 2652 <code>null</code>) 2653 * @return the group 2654 * @throws PortalException if a group with the primary key could not be 2655 found or if a valid friendly URL could not be created for the 2656 group 2657 * @throws SystemException if a system exception occurred 2658 */ 2659 public com.liferay.portal.model.Group updateFriendlyURL(long groupId, 2660 java.lang.String friendlyURL) 2661 throws com.liferay.portal.kernel.exception.PortalException, 2662 com.liferay.portal.kernel.exception.SystemException { 2663 return _groupLocalService.updateFriendlyURL(groupId, friendlyURL); 2664 } 2665 2666 /** 2667 * Updates the group. 2668 * 2669 * @param groupId the primary key of the group 2670 * @param parentGroupId the primary key of the parent group 2671 * @param name the group's new name 2672 * @param description the group's new description (optionally 2673 <code>null</code>) 2674 * @param type the group's new type. For more information see {@link 2675 com.liferay.portal.model.GroupConstants} 2676 * @param friendlyURL the group's new friendlyURL (optionally 2677 <code>null</code>) 2678 * @param active whether the group is active 2679 * @param serviceContext the service context to be applied (optionally 2680 <code>null</code>). Can set asset category IDs and asset tag 2681 names for the group. 2682 * @return the group 2683 * @throws PortalException if a group with the primary key could not be 2684 found or if the friendly URL was invalid or could one not be 2685 created 2686 * @throws SystemException if a system exception occurred 2687 */ 2688 public com.liferay.portal.model.Group updateGroup(long groupId, 2689 long parentGroupId, java.lang.String name, 2690 java.lang.String description, int type, java.lang.String friendlyURL, 2691 boolean active, com.liferay.portal.service.ServiceContext serviceContext) 2692 throws com.liferay.portal.kernel.exception.PortalException, 2693 com.liferay.portal.kernel.exception.SystemException { 2694 return _groupLocalService.updateGroup(groupId, parentGroupId, name, 2695 description, type, friendlyURL, active, serviceContext); 2696 } 2697 2698 /** 2699 * Updates the group's type settings. 2700 * 2701 * @param groupId the primary key of the group 2702 * @param typeSettings the group's new type settings (optionally 2703 <code>null</code>) 2704 * @return the group 2705 * @throws PortalException if a group with the primary key could not be 2706 found 2707 * @throws SystemException if a system exception occurred 2708 */ 2709 public com.liferay.portal.model.Group updateGroup(long groupId, 2710 java.lang.String typeSettings) 2711 throws com.liferay.portal.kernel.exception.PortalException, 2712 com.liferay.portal.kernel.exception.SystemException { 2713 return _groupLocalService.updateGroup(groupId, typeSettings); 2714 } 2715 2716 /** 2717 * Associates the group with a main site if the group is an organization. 2718 * 2719 * @param groupId the primary key of the group 2720 * @param site whether the group is to be associated with a main site 2721 * @return the group 2722 * @throws PortalException if a group with the primary key could not be 2723 found 2724 * @throws SystemException if a system exception occurred 2725 */ 2726 public com.liferay.portal.model.Group updateSite(long groupId, boolean site) 2727 throws com.liferay.portal.kernel.exception.PortalException, 2728 com.liferay.portal.kernel.exception.SystemException { 2729 return _groupLocalService.updateSite(groupId, site); 2730 } 2731 2732 /** 2733 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 2734 */ 2735 public GroupLocalService getWrappedGroupLocalService() { 2736 return _groupLocalService; 2737 } 2738 2739 /** 2740 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 2741 */ 2742 public void setWrappedGroupLocalService(GroupLocalService groupLocalService) { 2743 _groupLocalService = groupLocalService; 2744 } 2745 2746 public GroupLocalService getWrappedService() { 2747 return _groupLocalService; 2748 } 2749 2750 public void setWrappedService(GroupLocalService groupLocalService) { 2751 _groupLocalService = groupLocalService; 2752 } 2753 2754 private GroupLocalService _groupLocalService; 2755 }