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.persistence; 016 017 import com.liferay.portal.model.UserGroup; 018 019 /** 020 * The persistence interface for the user group service. 021 * 022 * <p> 023 * Caching information and settings can be found in <code>portal.properties</code> 024 * </p> 025 * 026 * @author Brian Wing Shun Chan 027 * @see UserGroupPersistenceImpl 028 * @see UserGroupUtil 029 * @generated 030 */ 031 public interface UserGroupPersistence extends BasePersistence<UserGroup> { 032 /* 033 * NOTE FOR DEVELOPERS: 034 * 035 * Never modify or reference this interface directly. Always use {@link UserGroupUtil} to access the user group persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 036 */ 037 038 /** 039 * Returns all the user groups where companyId = ?. 040 * 041 * @param companyId the company ID 042 * @return the matching user groups 043 * @throws SystemException if a system exception occurred 044 */ 045 public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId( 046 long companyId) 047 throws com.liferay.portal.kernel.exception.SystemException; 048 049 /** 050 * Returns a range of all the user groups where companyId = ?. 051 * 052 * <p> 053 * 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. 054 * </p> 055 * 056 * @param companyId the company ID 057 * @param start the lower bound of the range of user groups 058 * @param end the upper bound of the range of user groups (not inclusive) 059 * @return the range of matching user groups 060 * @throws SystemException if a system exception occurred 061 */ 062 public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId( 063 long companyId, int start, int end) 064 throws com.liferay.portal.kernel.exception.SystemException; 065 066 /** 067 * Returns an ordered range of all the user groups where companyId = ?. 068 * 069 * <p> 070 * 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. 071 * </p> 072 * 073 * @param companyId the company ID 074 * @param start the lower bound of the range of user groups 075 * @param end the upper bound of the range of user groups (not inclusive) 076 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 077 * @return the ordered range of matching user groups 078 * @throws SystemException if a system exception occurred 079 */ 080 public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId( 081 long companyId, int start, int end, 082 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 083 throws com.liferay.portal.kernel.exception.SystemException; 084 085 /** 086 * Returns the first user group in the ordered set where companyId = ?. 087 * 088 * @param companyId the company ID 089 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 090 * @return the first matching user group 091 * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found 092 * @throws SystemException if a system exception occurred 093 */ 094 public com.liferay.portal.model.UserGroup findByCompanyId_First( 095 long companyId, 096 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 097 throws com.liferay.portal.NoSuchUserGroupException, 098 com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Returns the first user group in the ordered set where companyId = ?. 102 * 103 * @param companyId the company ID 104 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 105 * @return the first matching user group, or <code>null</code> if a matching user group could not be found 106 * @throws SystemException if a system exception occurred 107 */ 108 public com.liferay.portal.model.UserGroup fetchByCompanyId_First( 109 long companyId, 110 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 111 throws com.liferay.portal.kernel.exception.SystemException; 112 113 /** 114 * Returns the last user group in the ordered set where companyId = ?. 115 * 116 * @param companyId the company ID 117 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 118 * @return the last matching user group 119 * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found 120 * @throws SystemException if a system exception occurred 121 */ 122 public com.liferay.portal.model.UserGroup findByCompanyId_Last( 123 long companyId, 124 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 125 throws com.liferay.portal.NoSuchUserGroupException, 126 com.liferay.portal.kernel.exception.SystemException; 127 128 /** 129 * Returns the last user group in the ordered set where companyId = ?. 130 * 131 * @param companyId the company ID 132 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 133 * @return the last matching user group, or <code>null</code> if a matching user group could not be found 134 * @throws SystemException if a system exception occurred 135 */ 136 public com.liferay.portal.model.UserGroup fetchByCompanyId_Last( 137 long companyId, 138 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 139 throws com.liferay.portal.kernel.exception.SystemException; 140 141 /** 142 * Returns the user groups before and after the current user group in the ordered set where companyId = ?. 143 * 144 * @param userGroupId the primary key of the current user group 145 * @param companyId the company ID 146 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 147 * @return the previous, current, and next user group 148 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 149 * @throws SystemException if a system exception occurred 150 */ 151 public com.liferay.portal.model.UserGroup[] findByCompanyId_PrevAndNext( 152 long userGroupId, long companyId, 153 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 154 throws com.liferay.portal.NoSuchUserGroupException, 155 com.liferay.portal.kernel.exception.SystemException; 156 157 /** 158 * Returns all the user groups that the user has permission to view where companyId = ?. 159 * 160 * @param companyId the company ID 161 * @return the matching user groups that the user has permission to view 162 * @throws SystemException if a system exception occurred 163 */ 164 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId( 165 long companyId) 166 throws com.liferay.portal.kernel.exception.SystemException; 167 168 /** 169 * Returns a range of all the user groups that the user has permission to view where companyId = ?. 170 * 171 * <p> 172 * 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. 173 * </p> 174 * 175 * @param companyId the company ID 176 * @param start the lower bound of the range of user groups 177 * @param end the upper bound of the range of user groups (not inclusive) 178 * @return the range of matching user groups that the user has permission to view 179 * @throws SystemException if a system exception occurred 180 */ 181 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId( 182 long companyId, int start, int end) 183 throws com.liferay.portal.kernel.exception.SystemException; 184 185 /** 186 * Returns an ordered range of all the user groups that the user has permissions to view where companyId = ?. 187 * 188 * <p> 189 * 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. 190 * </p> 191 * 192 * @param companyId the company ID 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 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 196 * @return the ordered range of matching user groups that the user has permission to view 197 * @throws SystemException if a system exception occurred 198 */ 199 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId( 200 long companyId, int start, int end, 201 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 202 throws com.liferay.portal.kernel.exception.SystemException; 203 204 /** 205 * Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ?. 206 * 207 * @param userGroupId the primary key of the current user group 208 * @param companyId the company ID 209 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 210 * @return the previous, current, and next user group 211 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 212 * @throws SystemException if a system exception occurred 213 */ 214 public com.liferay.portal.model.UserGroup[] filterFindByCompanyId_PrevAndNext( 215 long userGroupId, long companyId, 216 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 217 throws com.liferay.portal.NoSuchUserGroupException, 218 com.liferay.portal.kernel.exception.SystemException; 219 220 /** 221 * Removes all the user groups where companyId = ? from the database. 222 * 223 * @param companyId the company ID 224 * @throws SystemException if a system exception occurred 225 */ 226 public void removeByCompanyId(long companyId) 227 throws com.liferay.portal.kernel.exception.SystemException; 228 229 /** 230 * Returns the number of user groups where companyId = ?. 231 * 232 * @param companyId the company ID 233 * @return the number of matching user groups 234 * @throws SystemException if a system exception occurred 235 */ 236 public int countByCompanyId(long companyId) 237 throws com.liferay.portal.kernel.exception.SystemException; 238 239 /** 240 * Returns the number of user groups that the user has permission to view where companyId = ?. 241 * 242 * @param companyId the company ID 243 * @return the number of matching user groups that the user has permission to view 244 * @throws SystemException if a system exception occurred 245 */ 246 public int filterCountByCompanyId(long companyId) 247 throws com.liferay.portal.kernel.exception.SystemException; 248 249 /** 250 * Returns all the user groups where companyId = ? and parentUserGroupId = ?. 251 * 252 * @param companyId the company ID 253 * @param parentUserGroupId the parent user group ID 254 * @return the matching user groups 255 * @throws SystemException if a system exception occurred 256 */ 257 public java.util.List<com.liferay.portal.model.UserGroup> findByC_P( 258 long companyId, long parentUserGroupId) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 /** 262 * Returns a range of all the user groups where companyId = ? and parentUserGroupId = ?. 263 * 264 * <p> 265 * 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. 266 * </p> 267 * 268 * @param companyId the company ID 269 * @param parentUserGroupId the parent user group ID 270 * @param start the lower bound of the range of user groups 271 * @param end the upper bound of the range of user groups (not inclusive) 272 * @return the range of matching user groups 273 * @throws SystemException if a system exception occurred 274 */ 275 public java.util.List<com.liferay.portal.model.UserGroup> findByC_P( 276 long companyId, long parentUserGroupId, int start, int end) 277 throws com.liferay.portal.kernel.exception.SystemException; 278 279 /** 280 * Returns an ordered range of all the user groups where companyId = ? and parentUserGroupId = ?. 281 * 282 * <p> 283 * 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. 284 * </p> 285 * 286 * @param companyId the company ID 287 * @param parentUserGroupId the parent user group ID 288 * @param start the lower bound of the range of user groups 289 * @param end the upper bound of the range of user groups (not inclusive) 290 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 291 * @return the ordered range of matching user groups 292 * @throws SystemException if a system exception occurred 293 */ 294 public java.util.List<com.liferay.portal.model.UserGroup> findByC_P( 295 long companyId, long parentUserGroupId, int start, int end, 296 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 297 throws com.liferay.portal.kernel.exception.SystemException; 298 299 /** 300 * Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?. 301 * 302 * @param companyId the company ID 303 * @param parentUserGroupId the parent user group ID 304 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 305 * @return the first matching user group 306 * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found 307 * @throws SystemException if a system exception occurred 308 */ 309 public com.liferay.portal.model.UserGroup findByC_P_First(long companyId, 310 long parentUserGroupId, 311 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 312 throws com.liferay.portal.NoSuchUserGroupException, 313 com.liferay.portal.kernel.exception.SystemException; 314 315 /** 316 * Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?. 317 * 318 * @param companyId the company ID 319 * @param parentUserGroupId the parent user group ID 320 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 321 * @return the first matching user group, or <code>null</code> if a matching user group could not be found 322 * @throws SystemException if a system exception occurred 323 */ 324 public com.liferay.portal.model.UserGroup fetchByC_P_First(long companyId, 325 long parentUserGroupId, 326 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 327 throws com.liferay.portal.kernel.exception.SystemException; 328 329 /** 330 * Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?. 331 * 332 * @param companyId the company ID 333 * @param parentUserGroupId the parent user group ID 334 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 335 * @return the last matching user group 336 * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found 337 * @throws SystemException if a system exception occurred 338 */ 339 public com.liferay.portal.model.UserGroup findByC_P_Last(long companyId, 340 long parentUserGroupId, 341 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 342 throws com.liferay.portal.NoSuchUserGroupException, 343 com.liferay.portal.kernel.exception.SystemException; 344 345 /** 346 * Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?. 347 * 348 * @param companyId the company ID 349 * @param parentUserGroupId the parent user group ID 350 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 351 * @return the last matching user group, or <code>null</code> if a matching user group could not be found 352 * @throws SystemException if a system exception occurred 353 */ 354 public com.liferay.portal.model.UserGroup fetchByC_P_Last(long companyId, 355 long parentUserGroupId, 356 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 357 throws com.liferay.portal.kernel.exception.SystemException; 358 359 /** 360 * Returns the user groups before and after the current user group in the ordered set where companyId = ? and parentUserGroupId = ?. 361 * 362 * @param userGroupId the primary key of the current user group 363 * @param companyId the company ID 364 * @param parentUserGroupId the parent user group ID 365 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 366 * @return the previous, current, and next user group 367 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 368 * @throws SystemException if a system exception occurred 369 */ 370 public com.liferay.portal.model.UserGroup[] findByC_P_PrevAndNext( 371 long userGroupId, long companyId, long parentUserGroupId, 372 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 373 throws com.liferay.portal.NoSuchUserGroupException, 374 com.liferay.portal.kernel.exception.SystemException; 375 376 /** 377 * Returns all the user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?. 378 * 379 * @param companyId the company ID 380 * @param parentUserGroupId the parent user group ID 381 * @return the matching user groups that the user has permission to view 382 * @throws SystemException if a system exception occurred 383 */ 384 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P( 385 long companyId, long parentUserGroupId) 386 throws com.liferay.portal.kernel.exception.SystemException; 387 388 /** 389 * Returns a range of all the user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?. 390 * 391 * <p> 392 * 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. 393 * </p> 394 * 395 * @param companyId the company ID 396 * @param parentUserGroupId the parent user group ID 397 * @param start the lower bound of the range of user groups 398 * @param end the upper bound of the range of user groups (not inclusive) 399 * @return the range of matching user groups that the user has permission to view 400 * @throws SystemException if a system exception occurred 401 */ 402 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P( 403 long companyId, long parentUserGroupId, int start, int end) 404 throws com.liferay.portal.kernel.exception.SystemException; 405 406 /** 407 * Returns an ordered range of all the user groups that the user has permissions to view where companyId = ? and parentUserGroupId = ?. 408 * 409 * <p> 410 * 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. 411 * </p> 412 * 413 * @param companyId the company ID 414 * @param parentUserGroupId the parent user group ID 415 * @param start the lower bound of the range of user groups 416 * @param end the upper bound of the range of user groups (not inclusive) 417 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 418 * @return the ordered range of matching user groups that the user has permission to view 419 * @throws SystemException if a system exception occurred 420 */ 421 public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P( 422 long companyId, long parentUserGroupId, int start, int end, 423 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 424 throws com.liferay.portal.kernel.exception.SystemException; 425 426 /** 427 * Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?. 428 * 429 * @param userGroupId the primary key of the current user group 430 * @param companyId the company ID 431 * @param parentUserGroupId the parent user group ID 432 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 433 * @return the previous, current, and next user group 434 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 435 * @throws SystemException if a system exception occurred 436 */ 437 public com.liferay.portal.model.UserGroup[] filterFindByC_P_PrevAndNext( 438 long userGroupId, long companyId, long parentUserGroupId, 439 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 440 throws com.liferay.portal.NoSuchUserGroupException, 441 com.liferay.portal.kernel.exception.SystemException; 442 443 /** 444 * Removes all the user groups where companyId = ? and parentUserGroupId = ? from the database. 445 * 446 * @param companyId the company ID 447 * @param parentUserGroupId the parent user group ID 448 * @throws SystemException if a system exception occurred 449 */ 450 public void removeByC_P(long companyId, long parentUserGroupId) 451 throws com.liferay.portal.kernel.exception.SystemException; 452 453 /** 454 * Returns the number of user groups where companyId = ? and parentUserGroupId = ?. 455 * 456 * @param companyId the company ID 457 * @param parentUserGroupId the parent user group ID 458 * @return the number of matching user groups 459 * @throws SystemException if a system exception occurred 460 */ 461 public int countByC_P(long companyId, long parentUserGroupId) 462 throws com.liferay.portal.kernel.exception.SystemException; 463 464 /** 465 * Returns the number of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?. 466 * 467 * @param companyId the company ID 468 * @param parentUserGroupId the parent user group ID 469 * @return the number of matching user groups that the user has permission to view 470 * @throws SystemException if a system exception occurred 471 */ 472 public int filterCountByC_P(long companyId, long parentUserGroupId) 473 throws com.liferay.portal.kernel.exception.SystemException; 474 475 /** 476 * Returns the user group where companyId = ? and name = ? or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found. 477 * 478 * @param companyId the company ID 479 * @param name the name 480 * @return the matching user group 481 * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found 482 * @throws SystemException if a system exception occurred 483 */ 484 public com.liferay.portal.model.UserGroup findByC_N(long companyId, 485 java.lang.String name) 486 throws com.liferay.portal.NoSuchUserGroupException, 487 com.liferay.portal.kernel.exception.SystemException; 488 489 /** 490 * Returns the user group where companyId = ? and name = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 491 * 492 * @param companyId the company ID 493 * @param name the name 494 * @return the matching user group, or <code>null</code> if a matching user group could not be found 495 * @throws SystemException if a system exception occurred 496 */ 497 public com.liferay.portal.model.UserGroup fetchByC_N(long companyId, 498 java.lang.String name) 499 throws com.liferay.portal.kernel.exception.SystemException; 500 501 /** 502 * Returns the user group where companyId = ? and name = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 503 * 504 * @param companyId the company ID 505 * @param name the name 506 * @param retrieveFromCache whether to use the finder cache 507 * @return the matching user group, or <code>null</code> if a matching user group could not be found 508 * @throws SystemException if a system exception occurred 509 */ 510 public com.liferay.portal.model.UserGroup fetchByC_N(long companyId, 511 java.lang.String name, boolean retrieveFromCache) 512 throws com.liferay.portal.kernel.exception.SystemException; 513 514 /** 515 * Removes the user group where companyId = ? and name = ? from the database. 516 * 517 * @param companyId the company ID 518 * @param name the name 519 * @return the user group that was removed 520 * @throws SystemException if a system exception occurred 521 */ 522 public com.liferay.portal.model.UserGroup removeByC_N(long companyId, 523 java.lang.String name) 524 throws com.liferay.portal.NoSuchUserGroupException, 525 com.liferay.portal.kernel.exception.SystemException; 526 527 /** 528 * Returns the number of user groups where companyId = ? and name = ?. 529 * 530 * @param companyId the company ID 531 * @param name the name 532 * @return the number of matching user groups 533 * @throws SystemException if a system exception occurred 534 */ 535 public int countByC_N(long companyId, java.lang.String name) 536 throws com.liferay.portal.kernel.exception.SystemException; 537 538 /** 539 * Caches the user group in the entity cache if it is enabled. 540 * 541 * @param userGroup the user group 542 */ 543 public void cacheResult(com.liferay.portal.model.UserGroup userGroup); 544 545 /** 546 * Caches the user groups in the entity cache if it is enabled. 547 * 548 * @param userGroups the user groups 549 */ 550 public void cacheResult( 551 java.util.List<com.liferay.portal.model.UserGroup> userGroups); 552 553 /** 554 * Creates a new user group with the primary key. Does not add the user group to the database. 555 * 556 * @param userGroupId the primary key for the new user group 557 * @return the new user group 558 */ 559 public com.liferay.portal.model.UserGroup create(long userGroupId); 560 561 /** 562 * Removes the user group with the primary key from the database. Also notifies the appropriate model listeners. 563 * 564 * @param userGroupId the primary key of the user group 565 * @return the user group that was removed 566 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 567 * @throws SystemException if a system exception occurred 568 */ 569 public com.liferay.portal.model.UserGroup remove(long userGroupId) 570 throws com.liferay.portal.NoSuchUserGroupException, 571 com.liferay.portal.kernel.exception.SystemException; 572 573 public com.liferay.portal.model.UserGroup updateImpl( 574 com.liferay.portal.model.UserGroup userGroup) 575 throws com.liferay.portal.kernel.exception.SystemException; 576 577 /** 578 * Returns the user group with the primary key or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found. 579 * 580 * @param userGroupId the primary key of the user group 581 * @return the user group 582 * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found 583 * @throws SystemException if a system exception occurred 584 */ 585 public com.liferay.portal.model.UserGroup findByPrimaryKey(long userGroupId) 586 throws com.liferay.portal.NoSuchUserGroupException, 587 com.liferay.portal.kernel.exception.SystemException; 588 589 /** 590 * Returns the user group with the primary key or returns <code>null</code> if it could not be found. 591 * 592 * @param userGroupId the primary key of the user group 593 * @return the user group, or <code>null</code> if a user group with the primary key could not be found 594 * @throws SystemException if a system exception occurred 595 */ 596 public com.liferay.portal.model.UserGroup fetchByPrimaryKey( 597 long userGroupId) 598 throws com.liferay.portal.kernel.exception.SystemException; 599 600 /** 601 * Returns all the user groups. 602 * 603 * @return the user groups 604 * @throws SystemException if a system exception occurred 605 */ 606 public java.util.List<com.liferay.portal.model.UserGroup> findAll() 607 throws com.liferay.portal.kernel.exception.SystemException; 608 609 /** 610 * Returns a range of all the user groups. 611 * 612 * <p> 613 * 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. 614 * </p> 615 * 616 * @param start the lower bound of the range of user groups 617 * @param end the upper bound of the range of user groups (not inclusive) 618 * @return the range of user groups 619 * @throws SystemException if a system exception occurred 620 */ 621 public java.util.List<com.liferay.portal.model.UserGroup> findAll( 622 int start, int end) 623 throws com.liferay.portal.kernel.exception.SystemException; 624 625 /** 626 * Returns an ordered range of all the user groups. 627 * 628 * <p> 629 * 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. 630 * </p> 631 * 632 * @param start the lower bound of the range of user groups 633 * @param end the upper bound of the range of user groups (not inclusive) 634 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 635 * @return the ordered range of user groups 636 * @throws SystemException if a system exception occurred 637 */ 638 public java.util.List<com.liferay.portal.model.UserGroup> findAll( 639 int start, int end, 640 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 641 throws com.liferay.portal.kernel.exception.SystemException; 642 643 /** 644 * Removes all the user groups from the database. 645 * 646 * @throws SystemException if a system exception occurred 647 */ 648 public void removeAll() 649 throws com.liferay.portal.kernel.exception.SystemException; 650 651 /** 652 * Returns the number of user groups. 653 * 654 * @return the number of user groups 655 * @throws SystemException if a system exception occurred 656 */ 657 public int countAll() 658 throws com.liferay.portal.kernel.exception.SystemException; 659 660 /** 661 * Returns all the groups associated with the user group. 662 * 663 * @param pk the primary key of the user group 664 * @return the groups associated with the user group 665 * @throws SystemException if a system exception occurred 666 */ 667 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk) 668 throws com.liferay.portal.kernel.exception.SystemException; 669 670 /** 671 * Returns a range of all the groups associated with the user group. 672 * 673 * <p> 674 * 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. 675 * </p> 676 * 677 * @param pk the primary key of the user group 678 * @param start the lower bound of the range of user groups 679 * @param end the upper bound of the range of user groups (not inclusive) 680 * @return the range of groups associated with the user group 681 * @throws SystemException if a system exception occurred 682 */ 683 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk, 684 int start, int end) 685 throws com.liferay.portal.kernel.exception.SystemException; 686 687 /** 688 * Returns an ordered range of all the groups associated with the user group. 689 * 690 * <p> 691 * 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. 692 * </p> 693 * 694 * @param pk the primary key of the user group 695 * @param start the lower bound of the range of user groups 696 * @param end the upper bound of the range of user groups (not inclusive) 697 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 698 * @return the ordered range of groups associated with the user group 699 * @throws SystemException if a system exception occurred 700 */ 701 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk, 702 int start, int end, 703 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 704 throws com.liferay.portal.kernel.exception.SystemException; 705 706 /** 707 * Returns the number of groups associated with the user group. 708 * 709 * @param pk the primary key of the user group 710 * @return the number of groups associated with the user group 711 * @throws SystemException if a system exception occurred 712 */ 713 public int getGroupsSize(long pk) 714 throws com.liferay.portal.kernel.exception.SystemException; 715 716 /** 717 * Returns <code>true</code> if the group is associated with the user group. 718 * 719 * @param pk the primary key of the user group 720 * @param groupPK the primary key of the group 721 * @return <code>true</code> if the group is associated with the user group; <code>false</code> otherwise 722 * @throws SystemException if a system exception occurred 723 */ 724 public boolean containsGroup(long pk, long groupPK) 725 throws com.liferay.portal.kernel.exception.SystemException; 726 727 /** 728 * Returns <code>true</code> if the user group has any groups associated with it. 729 * 730 * @param pk the primary key of the user group to check for associations with groups 731 * @return <code>true</code> if the user group has any groups associated with it; <code>false</code> otherwise 732 * @throws SystemException if a system exception occurred 733 */ 734 public boolean containsGroups(long pk) 735 throws com.liferay.portal.kernel.exception.SystemException; 736 737 /** 738 * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 739 * 740 * @param pk the primary key of the user group 741 * @param groupPK the primary key of the group 742 * @throws SystemException if a system exception occurred 743 */ 744 public void addGroup(long pk, long groupPK) 745 throws com.liferay.portal.kernel.exception.SystemException; 746 747 /** 748 * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 749 * 750 * @param pk the primary key of the user group 751 * @param group the group 752 * @throws SystemException if a system exception occurred 753 */ 754 public void addGroup(long pk, com.liferay.portal.model.Group group) 755 throws com.liferay.portal.kernel.exception.SystemException; 756 757 /** 758 * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 759 * 760 * @param pk the primary key of the user group 761 * @param groupPKs the primary keys of the groups 762 * @throws SystemException if a system exception occurred 763 */ 764 public void addGroups(long pk, long[] groupPKs) 765 throws com.liferay.portal.kernel.exception.SystemException; 766 767 /** 768 * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 769 * 770 * @param pk the primary key of the user group 771 * @param groups the groups 772 * @throws SystemException if a system exception occurred 773 */ 774 public void addGroups(long pk, 775 java.util.List<com.liferay.portal.model.Group> groups) 776 throws com.liferay.portal.kernel.exception.SystemException; 777 778 /** 779 * Clears all associations between the user group and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 780 * 781 * @param pk the primary key of the user group to clear the associated groups from 782 * @throws SystemException if a system exception occurred 783 */ 784 public void clearGroups(long pk) 785 throws com.liferay.portal.kernel.exception.SystemException; 786 787 /** 788 * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 789 * 790 * @param pk the primary key of the user group 791 * @param groupPK the primary key of the group 792 * @throws SystemException if a system exception occurred 793 */ 794 public void removeGroup(long pk, long groupPK) 795 throws com.liferay.portal.kernel.exception.SystemException; 796 797 /** 798 * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 799 * 800 * @param pk the primary key of the user group 801 * @param group the group 802 * @throws SystemException if a system exception occurred 803 */ 804 public void removeGroup(long pk, com.liferay.portal.model.Group group) 805 throws com.liferay.portal.kernel.exception.SystemException; 806 807 /** 808 * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 809 * 810 * @param pk the primary key of the user group 811 * @param groupPKs the primary keys of the groups 812 * @throws SystemException if a system exception occurred 813 */ 814 public void removeGroups(long pk, long[] groupPKs) 815 throws com.liferay.portal.kernel.exception.SystemException; 816 817 /** 818 * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 819 * 820 * @param pk the primary key of the user group 821 * @param groups the groups 822 * @throws SystemException if a system exception occurred 823 */ 824 public void removeGroups(long pk, 825 java.util.List<com.liferay.portal.model.Group> groups) 826 throws com.liferay.portal.kernel.exception.SystemException; 827 828 /** 829 * Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 830 * 831 * @param pk the primary key of the user group 832 * @param groupPKs the primary keys of the groups to be associated with the user group 833 * @throws SystemException if a system exception occurred 834 */ 835 public void setGroups(long pk, long[] groupPKs) 836 throws com.liferay.portal.kernel.exception.SystemException; 837 838 /** 839 * Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 840 * 841 * @param pk the primary key of the user group 842 * @param groups the groups to be associated with the user group 843 * @throws SystemException if a system exception occurred 844 */ 845 public void setGroups(long pk, 846 java.util.List<com.liferay.portal.model.Group> groups) 847 throws com.liferay.portal.kernel.exception.SystemException; 848 849 /** 850 * Returns all the teams associated with the user group. 851 * 852 * @param pk the primary key of the user group 853 * @return the teams associated with the user group 854 * @throws SystemException if a system exception occurred 855 */ 856 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk) 857 throws com.liferay.portal.kernel.exception.SystemException; 858 859 /** 860 * Returns a range of all the teams associated with the user group. 861 * 862 * <p> 863 * 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. 864 * </p> 865 * 866 * @param pk the primary key of the user group 867 * @param start the lower bound of the range of user groups 868 * @param end the upper bound of the range of user groups (not inclusive) 869 * @return the range of teams associated with the user group 870 * @throws SystemException if a system exception occurred 871 */ 872 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk, 873 int start, int end) 874 throws com.liferay.portal.kernel.exception.SystemException; 875 876 /** 877 * Returns an ordered range of all the teams associated with the user group. 878 * 879 * <p> 880 * 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. 881 * </p> 882 * 883 * @param pk the primary key of the user group 884 * @param start the lower bound of the range of user groups 885 * @param end the upper bound of the range of user groups (not inclusive) 886 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 887 * @return the ordered range of teams associated with the user group 888 * @throws SystemException if a system exception occurred 889 */ 890 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk, 891 int start, int end, 892 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 893 throws com.liferay.portal.kernel.exception.SystemException; 894 895 /** 896 * Returns the number of teams associated with the user group. 897 * 898 * @param pk the primary key of the user group 899 * @return the number of teams associated with the user group 900 * @throws SystemException if a system exception occurred 901 */ 902 public int getTeamsSize(long pk) 903 throws com.liferay.portal.kernel.exception.SystemException; 904 905 /** 906 * Returns <code>true</code> if the team is associated with the user group. 907 * 908 * @param pk the primary key of the user group 909 * @param teamPK the primary key of the team 910 * @return <code>true</code> if the team is associated with the user group; <code>false</code> otherwise 911 * @throws SystemException if a system exception occurred 912 */ 913 public boolean containsTeam(long pk, long teamPK) 914 throws com.liferay.portal.kernel.exception.SystemException; 915 916 /** 917 * Returns <code>true</code> if the user group has any teams associated with it. 918 * 919 * @param pk the primary key of the user group to check for associations with teams 920 * @return <code>true</code> if the user group has any teams associated with it; <code>false</code> otherwise 921 * @throws SystemException if a system exception occurred 922 */ 923 public boolean containsTeams(long pk) 924 throws com.liferay.portal.kernel.exception.SystemException; 925 926 /** 927 * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 928 * 929 * @param pk the primary key of the user group 930 * @param teamPK the primary key of the team 931 * @throws SystemException if a system exception occurred 932 */ 933 public void addTeam(long pk, long teamPK) 934 throws com.liferay.portal.kernel.exception.SystemException; 935 936 /** 937 * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 938 * 939 * @param pk the primary key of the user group 940 * @param team the team 941 * @throws SystemException if a system exception occurred 942 */ 943 public void addTeam(long pk, com.liferay.portal.model.Team team) 944 throws com.liferay.portal.kernel.exception.SystemException; 945 946 /** 947 * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 948 * 949 * @param pk the primary key of the user group 950 * @param teamPKs the primary keys of the teams 951 * @throws SystemException if a system exception occurred 952 */ 953 public void addTeams(long pk, long[] teamPKs) 954 throws com.liferay.portal.kernel.exception.SystemException; 955 956 /** 957 * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 958 * 959 * @param pk the primary key of the user group 960 * @param teams the teams 961 * @throws SystemException if a system exception occurred 962 */ 963 public void addTeams(long pk, 964 java.util.List<com.liferay.portal.model.Team> teams) 965 throws com.liferay.portal.kernel.exception.SystemException; 966 967 /** 968 * Clears all associations between the user group and its teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 969 * 970 * @param pk the primary key of the user group to clear the associated teams from 971 * @throws SystemException if a system exception occurred 972 */ 973 public void clearTeams(long pk) 974 throws com.liferay.portal.kernel.exception.SystemException; 975 976 /** 977 * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 978 * 979 * @param pk the primary key of the user group 980 * @param teamPK the primary key of the team 981 * @throws SystemException if a system exception occurred 982 */ 983 public void removeTeam(long pk, long teamPK) 984 throws com.liferay.portal.kernel.exception.SystemException; 985 986 /** 987 * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 988 * 989 * @param pk the primary key of the user group 990 * @param team the team 991 * @throws SystemException if a system exception occurred 992 */ 993 public void removeTeam(long pk, com.liferay.portal.model.Team team) 994 throws com.liferay.portal.kernel.exception.SystemException; 995 996 /** 997 * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 998 * 999 * @param pk the primary key of the user group 1000 * @param teamPKs the primary keys of the teams 1001 * @throws SystemException if a system exception occurred 1002 */ 1003 public void removeTeams(long pk, long[] teamPKs) 1004 throws com.liferay.portal.kernel.exception.SystemException; 1005 1006 /** 1007 * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1008 * 1009 * @param pk the primary key of the user group 1010 * @param teams the teams 1011 * @throws SystemException if a system exception occurred 1012 */ 1013 public void removeTeams(long pk, 1014 java.util.List<com.liferay.portal.model.Team> teams) 1015 throws com.liferay.portal.kernel.exception.SystemException; 1016 1017 /** 1018 * Sets the teams associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1019 * 1020 * @param pk the primary key of the user group 1021 * @param teamPKs the primary keys of the teams to be associated with the user group 1022 * @throws SystemException if a system exception occurred 1023 */ 1024 public void setTeams(long pk, long[] teamPKs) 1025 throws com.liferay.portal.kernel.exception.SystemException; 1026 1027 /** 1028 * Sets the teams associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1029 * 1030 * @param pk the primary key of the user group 1031 * @param teams the teams to be associated with the user group 1032 * @throws SystemException if a system exception occurred 1033 */ 1034 public void setTeams(long pk, 1035 java.util.List<com.liferay.portal.model.Team> teams) 1036 throws com.liferay.portal.kernel.exception.SystemException; 1037 1038 /** 1039 * Returns all the users associated with the user group. 1040 * 1041 * @param pk the primary key of the user group 1042 * @return the users associated with the user group 1043 * @throws SystemException if a system exception occurred 1044 */ 1045 public java.util.List<com.liferay.portal.model.User> getUsers(long pk) 1046 throws com.liferay.portal.kernel.exception.SystemException; 1047 1048 /** 1049 * Returns a range of all the users associated with the user group. 1050 * 1051 * <p> 1052 * 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. 1053 * </p> 1054 * 1055 * @param pk the primary key of the user group 1056 * @param start the lower bound of the range of user groups 1057 * @param end the upper bound of the range of user groups (not inclusive) 1058 * @return the range of users associated with the user group 1059 * @throws SystemException if a system exception occurred 1060 */ 1061 public java.util.List<com.liferay.portal.model.User> getUsers(long pk, 1062 int start, int end) 1063 throws com.liferay.portal.kernel.exception.SystemException; 1064 1065 /** 1066 * Returns an ordered range of all the users associated with the user group. 1067 * 1068 * <p> 1069 * 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. 1070 * </p> 1071 * 1072 * @param pk the primary key of the user group 1073 * @param start the lower bound of the range of user groups 1074 * @param end the upper bound of the range of user groups (not inclusive) 1075 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1076 * @return the ordered range of users associated with the user group 1077 * @throws SystemException if a system exception occurred 1078 */ 1079 public java.util.List<com.liferay.portal.model.User> getUsers(long pk, 1080 int start, int end, 1081 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1082 throws com.liferay.portal.kernel.exception.SystemException; 1083 1084 /** 1085 * Returns the number of users associated with the user group. 1086 * 1087 * @param pk the primary key of the user group 1088 * @return the number of users associated with the user group 1089 * @throws SystemException if a system exception occurred 1090 */ 1091 public int getUsersSize(long pk) 1092 throws com.liferay.portal.kernel.exception.SystemException; 1093 1094 /** 1095 * Returns <code>true</code> if the user is associated with the user group. 1096 * 1097 * @param pk the primary key of the user group 1098 * @param userPK the primary key of the user 1099 * @return <code>true</code> if the user is associated with the user group; <code>false</code> otherwise 1100 * @throws SystemException if a system exception occurred 1101 */ 1102 public boolean containsUser(long pk, long userPK) 1103 throws com.liferay.portal.kernel.exception.SystemException; 1104 1105 /** 1106 * Returns <code>true</code> if the user group has any users associated with it. 1107 * 1108 * @param pk the primary key of the user group to check for associations with users 1109 * @return <code>true</code> if the user group has any users associated with it; <code>false</code> otherwise 1110 * @throws SystemException if a system exception occurred 1111 */ 1112 public boolean containsUsers(long pk) 1113 throws com.liferay.portal.kernel.exception.SystemException; 1114 1115 /** 1116 * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1117 * 1118 * @param pk the primary key of the user group 1119 * @param userPK the primary key of the user 1120 * @throws SystemException if a system exception occurred 1121 */ 1122 public void addUser(long pk, long userPK) 1123 throws com.liferay.portal.kernel.exception.SystemException; 1124 1125 /** 1126 * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1127 * 1128 * @param pk the primary key of the user group 1129 * @param user the user 1130 * @throws SystemException if a system exception occurred 1131 */ 1132 public void addUser(long pk, com.liferay.portal.model.User user) 1133 throws com.liferay.portal.kernel.exception.SystemException; 1134 1135 /** 1136 * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1137 * 1138 * @param pk the primary key of the user group 1139 * @param userPKs the primary keys of the users 1140 * @throws SystemException if a system exception occurred 1141 */ 1142 public void addUsers(long pk, long[] userPKs) 1143 throws com.liferay.portal.kernel.exception.SystemException; 1144 1145 /** 1146 * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1147 * 1148 * @param pk the primary key of the user group 1149 * @param users the users 1150 * @throws SystemException if a system exception occurred 1151 */ 1152 public void addUsers(long pk, 1153 java.util.List<com.liferay.portal.model.User> users) 1154 throws com.liferay.portal.kernel.exception.SystemException; 1155 1156 /** 1157 * Clears all associations between the user group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1158 * 1159 * @param pk the primary key of the user group to clear the associated users from 1160 * @throws SystemException if a system exception occurred 1161 */ 1162 public void clearUsers(long pk) 1163 throws com.liferay.portal.kernel.exception.SystemException; 1164 1165 /** 1166 * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1167 * 1168 * @param pk the primary key of the user group 1169 * @param userPK the primary key of the user 1170 * @throws SystemException if a system exception occurred 1171 */ 1172 public void removeUser(long pk, long userPK) 1173 throws com.liferay.portal.kernel.exception.SystemException; 1174 1175 /** 1176 * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1177 * 1178 * @param pk the primary key of the user group 1179 * @param user the user 1180 * @throws SystemException if a system exception occurred 1181 */ 1182 public void removeUser(long pk, com.liferay.portal.model.User user) 1183 throws com.liferay.portal.kernel.exception.SystemException; 1184 1185 /** 1186 * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1187 * 1188 * @param pk the primary key of the user group 1189 * @param userPKs the primary keys of the users 1190 * @throws SystemException if a system exception occurred 1191 */ 1192 public void removeUsers(long pk, long[] userPKs) 1193 throws com.liferay.portal.kernel.exception.SystemException; 1194 1195 /** 1196 * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1197 * 1198 * @param pk the primary key of the user group 1199 * @param users the users 1200 * @throws SystemException if a system exception occurred 1201 */ 1202 public void removeUsers(long pk, 1203 java.util.List<com.liferay.portal.model.User> users) 1204 throws com.liferay.portal.kernel.exception.SystemException; 1205 1206 /** 1207 * Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1208 * 1209 * @param pk the primary key of the user group 1210 * @param userPKs the primary keys of the users to be associated with the user group 1211 * @throws SystemException if a system exception occurred 1212 */ 1213 public void setUsers(long pk, long[] userPKs) 1214 throws com.liferay.portal.kernel.exception.SystemException; 1215 1216 /** 1217 * Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1218 * 1219 * @param pk the primary key of the user group 1220 * @param users the users to be associated with the user group 1221 * @throws SystemException if a system exception occurred 1222 */ 1223 public void setUsers(long pk, 1224 java.util.List<com.liferay.portal.model.User> users) 1225 throws com.liferay.portal.kernel.exception.SystemException; 1226 }