001 /** 002 * Copyright (c) 2000-2012 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 UserGroupLocalService}. 020 * </p> 021 * 022 * @author Brian Wing Shun Chan 023 * @see UserGroupLocalService 024 * @generated 025 */ 026 public class UserGroupLocalServiceWrapper implements UserGroupLocalService, 027 ServiceWrapper<UserGroupLocalService> { 028 public UserGroupLocalServiceWrapper( 029 UserGroupLocalService userGroupLocalService) { 030 _userGroupLocalService = userGroupLocalService; 031 } 032 033 /** 034 * Adds the user group to the database. Also notifies the appropriate model listeners. 035 * 036 * @param userGroup the user group 037 * @return the user group that was added 038 * @throws SystemException if a system exception occurred 039 */ 040 public com.liferay.portal.model.UserGroup addUserGroup( 041 com.liferay.portal.model.UserGroup userGroup) 042 throws com.liferay.portal.kernel.exception.SystemException { 043 return _userGroupLocalService.addUserGroup(userGroup); 044 } 045 046 /** 047 * Creates a new user group with the primary key. Does not add the user group to the database. 048 * 049 * @param userGroupId the primary key for the new user group 050 * @return the new user group 051 */ 052 public com.liferay.portal.model.UserGroup createUserGroup(long userGroupId) { 053 return _userGroupLocalService.createUserGroup(userGroupId); 054 } 055 056 /** 057 * Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners. 058 * 059 * @param userGroupId the primary key of the user group 060 * @return the user group that was removed 061 * @throws PortalException if a user group with the primary key could not be found 062 * @throws SystemException if a system exception occurred 063 */ 064 public com.liferay.portal.model.UserGroup deleteUserGroup(long userGroupId) 065 throws com.liferay.portal.kernel.exception.PortalException, 066 com.liferay.portal.kernel.exception.SystemException { 067 return _userGroupLocalService.deleteUserGroup(userGroupId); 068 } 069 070 /** 071 * Deletes the user group from the database. Also notifies the appropriate model listeners. 072 * 073 * @param userGroup the user group 074 * @return the user group that was removed 075 * @throws PortalException 076 * @throws SystemException if a system exception occurred 077 */ 078 public com.liferay.portal.model.UserGroup deleteUserGroup( 079 com.liferay.portal.model.UserGroup userGroup) 080 throws com.liferay.portal.kernel.exception.PortalException, 081 com.liferay.portal.kernel.exception.SystemException { 082 return _userGroupLocalService.deleteUserGroup(userGroup); 083 } 084 085 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 086 return _userGroupLocalService.dynamicQuery(); 087 } 088 089 /** 090 * Performs a dynamic query on the database and returns the matching rows. 091 * 092 * @param dynamicQuery the dynamic query 093 * @return the matching rows 094 * @throws SystemException if a system exception occurred 095 */ 096 @SuppressWarnings("rawtypes") 097 public java.util.List dynamicQuery( 098 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 099 throws com.liferay.portal.kernel.exception.SystemException { 100 return _userGroupLocalService.dynamicQuery(dynamicQuery); 101 } 102 103 /** 104 * Performs a dynamic query on the database and returns a range of the matching rows. 105 * 106 * <p> 107 * 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.UserGroupModelImpl}. 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. 108 * </p> 109 * 110 * @param dynamicQuery the dynamic query 111 * @param start the lower bound of the range of model instances 112 * @param end the upper bound of the range of model instances (not inclusive) 113 * @return the range of matching rows 114 * @throws SystemException if a system exception occurred 115 */ 116 @SuppressWarnings("rawtypes") 117 public java.util.List dynamicQuery( 118 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 119 int end) throws com.liferay.portal.kernel.exception.SystemException { 120 return _userGroupLocalService.dynamicQuery(dynamicQuery, start, end); 121 } 122 123 /** 124 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 125 * 126 * <p> 127 * 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.UserGroupModelImpl}. 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 134 * @return the ordered range of matching rows 135 * @throws SystemException if a system exception occurred 136 */ 137 @SuppressWarnings("rawtypes") 138 public java.util.List dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end, 141 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 142 throws com.liferay.portal.kernel.exception.SystemException { 143 return _userGroupLocalService.dynamicQuery(dynamicQuery, start, end, 144 orderByComparator); 145 } 146 147 /** 148 * Returns the number of rows that match the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows that match the dynamic query 152 * @throws SystemException if a system exception occurred 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 156 throws com.liferay.portal.kernel.exception.SystemException { 157 return _userGroupLocalService.dynamicQueryCount(dynamicQuery); 158 } 159 160 public com.liferay.portal.model.UserGroup fetchUserGroup(long userGroupId) 161 throws com.liferay.portal.kernel.exception.SystemException { 162 return _userGroupLocalService.fetchUserGroup(userGroupId); 163 } 164 165 /** 166 * Returns the user group with the primary key. 167 * 168 * @param userGroupId the primary key of the user group 169 * @return the user group 170 * @throws PortalException if a user group with the primary key could not be found 171 * @throws SystemException if a system exception occurred 172 */ 173 public com.liferay.portal.model.UserGroup getUserGroup(long userGroupId) 174 throws com.liferay.portal.kernel.exception.PortalException, 175 com.liferay.portal.kernel.exception.SystemException { 176 return _userGroupLocalService.getUserGroup(userGroupId); 177 } 178 179 public com.liferay.portal.model.PersistedModel getPersistedModel( 180 java.io.Serializable primaryKeyObj) 181 throws com.liferay.portal.kernel.exception.PortalException, 182 com.liferay.portal.kernel.exception.SystemException { 183 return _userGroupLocalService.getPersistedModel(primaryKeyObj); 184 } 185 186 /** 187 * Returns a range of all the user groups. 188 * 189 * <p> 190 * 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.UserGroupModelImpl}. 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. 191 * </p> 192 * 193 * @param start the lower bound of the range of user groups 194 * @param end the upper bound of the range of user groups (not inclusive) 195 * @return the range of user groups 196 * @throws SystemException if a system exception occurred 197 */ 198 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 199 int start, int end) 200 throws com.liferay.portal.kernel.exception.SystemException { 201 return _userGroupLocalService.getUserGroups(start, end); 202 } 203 204 /** 205 * Returns the number of user groups. 206 * 207 * @return the number of user groups 208 * @throws SystemException if a system exception occurred 209 */ 210 public int getUserGroupsCount() 211 throws com.liferay.portal.kernel.exception.SystemException { 212 return _userGroupLocalService.getUserGroupsCount(); 213 } 214 215 /** 216 * Updates the user group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 217 * 218 * @param userGroup the user group 219 * @return the user group that was updated 220 * @throws SystemException if a system exception occurred 221 */ 222 public com.liferay.portal.model.UserGroup updateUserGroup( 223 com.liferay.portal.model.UserGroup userGroup) 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return _userGroupLocalService.updateUserGroup(userGroup); 226 } 227 228 /** 229 * Returns the Spring bean ID for this bean. 230 * 231 * @return the Spring bean ID for this bean 232 */ 233 public java.lang.String getBeanIdentifier() { 234 return _userGroupLocalService.getBeanIdentifier(); 235 } 236 237 /** 238 * Sets the Spring bean ID for this bean. 239 * 240 * @param beanIdentifier the Spring bean ID for this bean 241 */ 242 public void setBeanIdentifier(java.lang.String beanIdentifier) { 243 _userGroupLocalService.setBeanIdentifier(beanIdentifier); 244 } 245 246 /** 247 * Adds the user groups to the group. 248 * 249 * @param groupId the primary key of the group 250 * @param userGroupIds the primary keys of the user groups 251 * @throws SystemException if a system exception occurred 252 */ 253 public void addGroupUserGroups(long groupId, long[] userGroupIds) 254 throws com.liferay.portal.kernel.exception.SystemException { 255 _userGroupLocalService.addGroupUserGroups(groupId, userGroupIds); 256 } 257 258 /** 259 * Adds the user groups to the team. 260 * 261 * @param teamId the primary key of the team 262 * @param userGroupIds the primary keys of the user groups 263 * @throws SystemException if a system exception occurred 264 */ 265 public void addTeamUserGroups(long teamId, long[] userGroupIds) 266 throws com.liferay.portal.kernel.exception.SystemException { 267 _userGroupLocalService.addTeamUserGroups(teamId, userGroupIds); 268 } 269 270 /** 271 * Adds a user group. 272 * 273 * <p> 274 * This method handles the creation and bookkeeping of the user group, 275 * including its resources, metadata, and internal data structures. It is 276 * not necessary to make subsequent calls to setup default groups and 277 * resources for the user group. 278 * </p> 279 * 280 * @param userId the primary key of the user 281 * @param companyId the primary key of the user group's company 282 * @param name the user group's name 283 * @param description the user group's description 284 * @return the user group 285 * @throws PortalException if the user group's information was invalid 286 * @throws SystemException if a system exception occurred 287 * @deprecated {@link #addUserGroup(long, long, String, String, 288 ServiceContext)} 289 */ 290 public com.liferay.portal.model.UserGroup addUserGroup(long userId, 291 long companyId, java.lang.String name, java.lang.String description) 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException { 294 return _userGroupLocalService.addUserGroup(userId, companyId, name, 295 description); 296 } 297 298 /** 299 * Adds a user group. 300 * 301 * <p> 302 * This method handles the creation and bookkeeping of the user group, 303 * including its resources, metadata, and internal data structures. It is 304 * not necessary to make subsequent calls to setup default groups and 305 * resources for the user group. 306 * </p> 307 * 308 * @param userId the primary key of the user 309 * @param companyId the primary key of the user group's company 310 * @param name the user group's name 311 * @param description the user group's description 312 * @param serviceContext the user group's service context (optionally 313 <code>null</code>). Can set expando bridge attributes for the 314 user group. 315 * @return the user group 316 * @throws PortalException if the user group's information was invalid 317 * @throws SystemException if a system exception occurred 318 */ 319 public com.liferay.portal.model.UserGroup addUserGroup(long userId, 320 long companyId, java.lang.String name, java.lang.String description, 321 com.liferay.portal.service.ServiceContext serviceContext) 322 throws com.liferay.portal.kernel.exception.PortalException, 323 com.liferay.portal.kernel.exception.SystemException { 324 return _userGroupLocalService.addUserGroup(userId, companyId, name, 325 description, serviceContext); 326 } 327 328 /** 329 * Clears all associations between the user and its user groups and clears 330 * the permissions cache. 331 * 332 * <p> 333 * This method is called from {@link #deleteUserGroup(UserGroup)}. 334 * </p> 335 * 336 * @param userId the primary key of the user 337 * @throws SystemException if a system exception occurred 338 */ 339 public void clearUserUserGroups(long userId) 340 throws com.liferay.portal.kernel.exception.SystemException { 341 _userGroupLocalService.clearUserUserGroups(userId); 342 } 343 344 /** 345 * Copies the user group's layouts to the users who are not already members 346 * of the user group. 347 * 348 * @param userGroupId the primary key of the user group 349 * @param userIds the primary keys of the users 350 * @throws PortalException if any one of the users could not be found or 351 if a portal exception occurred 352 * @throws SystemException if a system exception occurred 353 * @deprecated 354 */ 355 public void copyUserGroupLayouts(long userGroupId, long[] userIds) 356 throws com.liferay.portal.kernel.exception.PortalException, 357 com.liferay.portal.kernel.exception.SystemException { 358 _userGroupLocalService.copyUserGroupLayouts(userGroupId, userIds); 359 } 360 361 /** 362 * Copies the user groups' layouts to the user. 363 * 364 * @param userGroupIds the primary keys of the user groups 365 * @param userId the primary key of the user 366 * @throws PortalException if a user with the primary key could not be 367 found or if a portal exception occurred 368 * @throws SystemException if a system exception occurred 369 * @deprecated 370 */ 371 public void copyUserGroupLayouts(long[] userGroupIds, long userId) 372 throws com.liferay.portal.kernel.exception.PortalException, 373 com.liferay.portal.kernel.exception.SystemException { 374 _userGroupLocalService.copyUserGroupLayouts(userGroupIds, userId); 375 } 376 377 /** 378 * Copies the user group's layout to the user. 379 * 380 * @param userGroupId the primary key of the user group 381 * @param userId the primary key of the user 382 * @throws PortalException if a user with the primary key could not be 383 found or if a portal exception occurred 384 * @throws SystemException if a system exception occurred 385 * @deprecated 386 */ 387 public void copyUserGroupLayouts(long userGroupId, long userId) 388 throws com.liferay.portal.kernel.exception.PortalException, 389 com.liferay.portal.kernel.exception.SystemException { 390 _userGroupLocalService.copyUserGroupLayouts(userGroupId, userId); 391 } 392 393 /** 394 * Returns the user group with the name. 395 * 396 * @param companyId the primary key of the user group's company 397 * @param name the user group's name 398 * @return Returns the user group with the name 399 * @throws PortalException if a user group with the name could not be found 400 * @throws SystemException if a system exception occurred 401 */ 402 public com.liferay.portal.model.UserGroup getUserGroup(long companyId, 403 java.lang.String name) 404 throws com.liferay.portal.kernel.exception.PortalException, 405 com.liferay.portal.kernel.exception.SystemException { 406 return _userGroupLocalService.getUserGroup(companyId, name); 407 } 408 409 /** 410 * Returns all the user groups belonging to the company. 411 * 412 * @param companyId the primary key of the user groups' company 413 * @return the user groups belonging to the company 414 * @throws SystemException if a system exception occurred 415 */ 416 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 417 long companyId) 418 throws com.liferay.portal.kernel.exception.SystemException { 419 return _userGroupLocalService.getUserGroups(companyId); 420 } 421 422 /** 423 * Returns all the user groups with the primary keys. 424 * 425 * @param userGroupIds the primary keys of the user groups 426 * @return the user groups with the primary keys 427 * @throws PortalException if any one of the user groups could not be found 428 * @throws SystemException if a system exception occurred 429 */ 430 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 431 long[] userGroupIds) 432 throws com.liferay.portal.kernel.exception.PortalException, 433 com.liferay.portal.kernel.exception.SystemException { 434 return _userGroupLocalService.getUserGroups(userGroupIds); 435 } 436 437 /** 438 * Returns all the user groups to which the user belongs. 439 * 440 * @param userId the primary key of the user 441 * @return the user groups to which the user belongs 442 * @throws SystemException if a system exception occurred 443 */ 444 public java.util.List<com.liferay.portal.model.UserGroup> getUserUserGroups( 445 long userId) throws com.liferay.portal.kernel.exception.SystemException { 446 return _userGroupLocalService.getUserUserGroups(userId); 447 } 448 449 /** 450 * Returns <code>true</code> if the user group is associated with the group. 451 * 452 * @param groupId the primary key of the group 453 * @param userGroupId the primary key of the user group 454 * @return <code>true</code> if the user group belongs to the group; 455 <code>false</code> otherwise 456 * @throws SystemException if a system exception occurred 457 */ 458 public boolean hasGroupUserGroup(long groupId, long userGroupId) 459 throws com.liferay.portal.kernel.exception.SystemException { 460 return _userGroupLocalService.hasGroupUserGroup(groupId, userGroupId); 461 } 462 463 /** 464 * Returns <code>true</code> if the user group belongs to the team. 465 * 466 * @param teamId the primary key of the team 467 * @param userGroupId the primary key of the user group 468 * @return <code>true</code> if the user group belongs to the team; 469 <code>false</code> otherwise 470 * @throws SystemException if a system exception occurred 471 */ 472 public boolean hasTeamUserGroup(long teamId, long userGroupId) 473 throws com.liferay.portal.kernel.exception.SystemException { 474 return _userGroupLocalService.hasTeamUserGroup(teamId, userGroupId); 475 } 476 477 /** 478 * Returns an ordered range of all the user groups that match the keywords. 479 * 480 * <p> 481 * Useful when paginating results. Returns a maximum of <code>end - 482 * start</code> instances. <code>start</code> and <code>end</code> are not 483 * primary keys, they are indexes in the result set. Thus, <code>0</code> 484 * refers to the first result in the set. Setting both <code>start</code> 485 * and <code>end</code> to {@link 486 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 487 * result set. 488 * </p> 489 * 490 * @param companyId the primary key of the user group's company 491 * @param keywords the keywords (space separated), which may occur in the 492 user group's name or description (optionally <code>null</code>) 493 * @param params the finder params (optionally <code>null</code>). For more 494 information see {@link 495 com.liferay.portal.service.persistence.UserGroupFinder} 496 * @param start the lower bound of the range of user groups to return 497 * @param end the upper bound of the range of user groups to return (not 498 inclusive) 499 * @param obc the comparator to order the user groups (optionally 500 <code>null</code>) 501 * @return the matching user groups ordered by comparator <code>obc</code> 502 * @throws SystemException if a system exception occurred 503 * @see com.liferay.portal.service.persistence.UserGroupFinder 504 */ 505 public java.util.List<com.liferay.portal.model.UserGroup> search( 506 long companyId, java.lang.String keywords, 507 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 508 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 509 throws com.liferay.portal.kernel.exception.SystemException { 510 return _userGroupLocalService.search(companyId, keywords, params, 511 start, end, obc); 512 } 513 514 /** 515 * Returns an ordered range of all the user groups that match the keywords, 516 * using the indexer. It is preferable to use this method instead of the 517 * non-indexed version whenever possible for performance reasons. 518 * 519 * <p> 520 * Useful when paginating results. Returns a maximum of <code>end - 521 * start</code> instances. <code>start</code> and <code>end</code> are not 522 * primary keys, they are indexes in the result set. Thus, <code>0</code> 523 * refers to the first result in the set. Setting both <code>start</code> 524 * and <code>end</code> to {@link 525 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 526 * result set. 527 * </p> 528 * 529 * @param companyId the primary key of the user group's company 530 * @param keywords the keywords (space separated), which may occur in the 531 user group's name or description (optionally <code>null</code>) 532 * @param params the finder params (optionally <code>null</code>). For more 533 information see {@link 534 com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer} 535 * @param start the lower bound of the range of user groups to return 536 * @param end the upper bound of the range of user groups to return (not 537 inclusive) 538 * @param sort the field and direction by which to sort (optionally 539 <code>null</code>) 540 * @return the matching user groups ordered by sort 541 * @throws SystemException if a system exception occurred 542 * @see com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer 543 */ 544 public com.liferay.portal.kernel.search.Hits search(long companyId, 545 java.lang.String keywords, 546 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 547 int start, int end, com.liferay.portal.kernel.search.Sort sort) 548 throws com.liferay.portal.kernel.exception.SystemException { 549 return _userGroupLocalService.search(companyId, keywords, params, 550 start, end, sort); 551 } 552 553 /** 554 * Returns an ordered range of all the user groups that match the name and 555 * description. It is preferable to use this method instead of the 556 * non-indexed version whenever possible for performance reasons. 557 * 558 * <p> 559 * Useful when paginating results. Returns a maximum of <code>end - 560 * start</code> instances. <code>start</code> and <code>end</code> are not 561 * primary keys, they are indexes in the result set. Thus, <code>0</code> 562 * refers to the first result in the set. Setting both <code>start</code> 563 * and <code>end</code> to {@link 564 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 565 * result set. 566 * </p> 567 * 568 * @param companyId the primary key of the user group's company 569 * @param name the user group's name (optionally <code>null</code>) 570 * @param description the user group's description (optionally 571 <code>null</code>) 572 * @param params the finder params (optionally <code>null</code>). For more 573 information see {@link 574 com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer} 575 * @param andSearch whether every field must match its keywords or just one 576 field 577 * @param start the lower bound of the range of user groups to return 578 * @param end the upper bound of the range of user groups to return (not 579 inclusive) 580 * @param sort the field and direction by which to sort (optionally 581 <code>null</code>) 582 * @return the matching user groups ordered by sort 583 * @throws SystemException if a system exception occurred 584 * @see com.liferay.portal.service.persistence.UserGroupFinder 585 */ 586 public com.liferay.portal.kernel.search.Hits search(long companyId, 587 java.lang.String name, java.lang.String description, 588 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 589 boolean andSearch, int start, int end, 590 com.liferay.portal.kernel.search.Sort sort) 591 throws com.liferay.portal.kernel.exception.SystemException { 592 return _userGroupLocalService.search(companyId, name, description, 593 params, andSearch, start, end, sort); 594 } 595 596 /** 597 * Returns an ordered range of all the user groups that match the name and 598 * description. 599 * 600 * <p> 601 * Useful when paginating results. Returns a maximum of <code>end - 602 * start</code> instances. <code>start</code> and <code>end</code> are not 603 * primary keys, they are indexes in the result set. Thus, <code>0</code> 604 * refers to the first result in the set. Setting both <code>start</code> 605 * and <code>end</code> to {@link 606 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 607 * result set. 608 * </p> 609 * 610 * @param companyId the primary key of the user group's company 611 * @param name the user group's name (optionally <code>null</code>) 612 * @param description the user group's description (optionally 613 <code>null</code>) 614 * @param params the finder params (optionally <code>null</code>). For more 615 information see {@link 616 com.liferay.portal.service.persistence.UserGroupFinder} 617 * @param start the lower bound of the range of user groups to return 618 * @param end the upper bound of the range of user groups to return (not 619 inclusive) 620 * @param obc the comparator to order the user groups (optionally 621 <code>null</code>) 622 * @return the matching user groups ordered by comparator <code>obc</code> 623 * @throws SystemException if a system exception occurred 624 * @see com.liferay.portal.service.persistence.UserGroupFinder 625 */ 626 public java.util.List<com.liferay.portal.model.UserGroup> search( 627 long companyId, java.lang.String name, java.lang.String description, 628 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 629 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 630 throws com.liferay.portal.kernel.exception.SystemException { 631 return _userGroupLocalService.search(companyId, name, description, 632 params, start, end, obc); 633 } 634 635 /** 636 * Returns the number of user groups that match the keywords 637 * 638 * @param companyId the primary key of the user group's company 639 * @param keywords the keywords (space separated), which may occur in the 640 user group's name or description (optionally <code>null</code>) 641 * @param params the finder params (optionally <code>null</code>). For more 642 information see {@link 643 com.liferay.portal.service.persistence.UserGroupFinder} 644 * @return the number of matching user groups 645 * @throws SystemException if a system exception occurred 646 * @see com.liferay.portal.service.persistence.UserGroupFinder 647 */ 648 public int searchCount(long companyId, java.lang.String keywords, 649 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 650 throws com.liferay.portal.kernel.exception.SystemException { 651 return _userGroupLocalService.searchCount(companyId, keywords, params); 652 } 653 654 /** 655 * Returns the number of user groups that match the name and description. 656 * 657 * @param companyId the primary key of the user group's company 658 * @param name the user group's name (optionally <code>null</code>) 659 * @param description the user group's description (optionally 660 <code>null</code>) 661 * @param params the finder params (optionally <code>null</code>). For more 662 information see {@link 663 com.liferay.portal.service.persistence.UserGroupFinder} 664 * @return the number of matching user groups 665 * @throws SystemException if a system exception occurred 666 * @see com.liferay.portal.service.persistence.UserGroupFinder 667 */ 668 public int searchCount(long companyId, java.lang.String name, 669 java.lang.String description, 670 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 671 throws com.liferay.portal.kernel.exception.SystemException { 672 return _userGroupLocalService.searchCount(companyId, name, description, 673 params); 674 } 675 676 /** 677 * Sets the user groups associated with the user copying the user group 678 * layouts and removing and adding user group associations for the user as 679 * necessary. 680 * 681 * @param userId the primary key of the user 682 * @param userGroupIds the primary keys of the user groups 683 * @throws PortalException if a portal exception occurred 684 * @throws SystemException if a system exception occurred 685 */ 686 public void setUserUserGroups(long userId, long[] userGroupIds) 687 throws com.liferay.portal.kernel.exception.PortalException, 688 com.liferay.portal.kernel.exception.SystemException { 689 _userGroupLocalService.setUserUserGroups(userId, userGroupIds); 690 } 691 692 /** 693 * Removes the user groups from the group. 694 * 695 * @param groupId the primary key of the group 696 * @param userGroupIds the primary keys of the user groups 697 * @throws SystemException if a system exception occurred 698 */ 699 public void unsetGroupUserGroups(long groupId, long[] userGroupIds) 700 throws com.liferay.portal.kernel.exception.SystemException { 701 _userGroupLocalService.unsetGroupUserGroups(groupId, userGroupIds); 702 } 703 704 /** 705 * Removes the user groups from the team. 706 * 707 * @param teamId the primary key of the team 708 * @param userGroupIds the primary keys of the user groups 709 * @throws SystemException if a system exception occurred 710 */ 711 public void unsetTeamUserGroups(long teamId, long[] userGroupIds) 712 throws com.liferay.portal.kernel.exception.SystemException { 713 _userGroupLocalService.unsetTeamUserGroups(teamId, userGroupIds); 714 } 715 716 /** 717 * Updates the user group. 718 * 719 * @param companyId the primary key of the user group's company 720 * @param userGroupId the primary key of the user group 721 * @param name the user group's name 722 * @param description the user group's description 723 * @return the user group 724 * @throws PortalException if a user group with the primary key could 725 not be found or if the new information was invalid 726 * @throws SystemException if a system exception occurred 727 * @deprecated {@link #updateUserGroup(long, long, String, String, 728 ServiceContext)} 729 */ 730 public com.liferay.portal.model.UserGroup updateUserGroup(long companyId, 731 long userGroupId, java.lang.String name, java.lang.String description) 732 throws com.liferay.portal.kernel.exception.PortalException, 733 com.liferay.portal.kernel.exception.SystemException { 734 return _userGroupLocalService.updateUserGroup(companyId, userGroupId, 735 name, description); 736 } 737 738 /** 739 * Updates the user group. 740 * 741 * @param companyId the primary key of the user group's company 742 * @param userGroupId the primary key of the user group 743 * @param name the user group's name 744 * @param description the user group's description 745 * @param serviceContext the user group's service context (optionally 746 <code>null</code>). Can set expando bridge attributes for the 747 user group. 748 * @return the user group 749 * @throws PortalException if a user group with the primary key could not be 750 found or if the new information was invalid 751 * @throws SystemException if a system exception occurred 752 */ 753 public com.liferay.portal.model.UserGroup updateUserGroup(long companyId, 754 long userGroupId, java.lang.String name, java.lang.String description, 755 com.liferay.portal.service.ServiceContext serviceContext) 756 throws com.liferay.portal.kernel.exception.PortalException, 757 com.liferay.portal.kernel.exception.SystemException { 758 return _userGroupLocalService.updateUserGroup(companyId, userGroupId, 759 name, description, serviceContext); 760 } 761 762 /** 763 * @deprecated Renamed to {@link #getWrappedService} 764 */ 765 public UserGroupLocalService getWrappedUserGroupLocalService() { 766 return _userGroupLocalService; 767 } 768 769 /** 770 * @deprecated Renamed to {@link #setWrappedService} 771 */ 772 public void setWrappedUserGroupLocalService( 773 UserGroupLocalService userGroupLocalService) { 774 _userGroupLocalService = userGroupLocalService; 775 } 776 777 public UserGroupLocalService getWrappedService() { 778 return _userGroupLocalService; 779 } 780 781 public void setWrappedService(UserGroupLocalService userGroupLocalService) { 782 _userGroupLocalService = userGroupLocalService; 783 } 784 785 private UserGroupLocalService _userGroupLocalService; 786 }