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.User; 018 019 /** 020 * The persistence interface for the user 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 UserPersistenceImpl 028 * @see UserUtil 029 * @generated 030 */ 031 public interface UserPersistence extends BasePersistence<User> { 032 /* 033 * NOTE FOR DEVELOPERS: 034 * 035 * Never modify or reference this interface directly. Always use {@link UserUtil} to access the user persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 036 */ 037 038 /** 039 * Caches the user in the entity cache if it is enabled. 040 * 041 * @param user the user 042 */ 043 public void cacheResult(com.liferay.portal.model.User user); 044 045 /** 046 * Caches the users in the entity cache if it is enabled. 047 * 048 * @param users the users 049 */ 050 public void cacheResult(java.util.List<com.liferay.portal.model.User> users); 051 052 /** 053 * Creates a new user with the primary key. Does not add the user to the database. 054 * 055 * @param userId the primary key for the new user 056 * @return the new user 057 */ 058 public com.liferay.portal.model.User create(long userId); 059 060 /** 061 * Removes the user with the primary key from the database. Also notifies the appropriate model listeners. 062 * 063 * @param userId the primary key of the user 064 * @return the user that was removed 065 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 066 * @throws SystemException if a system exception occurred 067 */ 068 public com.liferay.portal.model.User remove(long userId) 069 throws com.liferay.portal.NoSuchUserException, 070 com.liferay.portal.kernel.exception.SystemException; 071 072 public com.liferay.portal.model.User updateImpl( 073 com.liferay.portal.model.User user) 074 throws com.liferay.portal.kernel.exception.SystemException; 075 076 /** 077 * Returns the user with the primary key or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 078 * 079 * @param userId the primary key of the user 080 * @return the user 081 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 082 * @throws SystemException if a system exception occurred 083 */ 084 public com.liferay.portal.model.User findByPrimaryKey(long userId) 085 throws com.liferay.portal.NoSuchUserException, 086 com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Returns the user with the primary key or returns <code>null</code> if it could not be found. 090 * 091 * @param userId the primary key of the user 092 * @return the user, or <code>null</code> if a user with the primary key could not be found 093 * @throws SystemException if a system exception occurred 094 */ 095 public com.liferay.portal.model.User fetchByPrimaryKey(long userId) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 /** 099 * Returns all the users where uuid = ?. 100 * 101 * @param uuid the uuid 102 * @return the matching users 103 * @throws SystemException if a system exception occurred 104 */ 105 public java.util.List<com.liferay.portal.model.User> findByUuid( 106 java.lang.String uuid) 107 throws com.liferay.portal.kernel.exception.SystemException; 108 109 /** 110 * Returns a range of all the users where uuid = ?. 111 * 112 * <p> 113 * 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. 114 * </p> 115 * 116 * @param uuid the uuid 117 * @param start the lower bound of the range of users 118 * @param end the upper bound of the range of users (not inclusive) 119 * @return the range of matching users 120 * @throws SystemException if a system exception occurred 121 */ 122 public java.util.List<com.liferay.portal.model.User> findByUuid( 123 java.lang.String uuid, int start, int end) 124 throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Returns an ordered range of all the users where uuid = ?. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param uuid the uuid 134 * @param start the lower bound of the range of users 135 * @param end the upper bound of the range of users (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching users 138 * @throws SystemException if a system exception occurred 139 */ 140 public java.util.List<com.liferay.portal.model.User> findByUuid( 141 java.lang.String uuid, int start, int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the first user in the ordered set where uuid = ?. 147 * 148 * @param uuid the uuid 149 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 150 * @return the first matching user 151 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 152 * @throws SystemException if a system exception occurred 153 */ 154 public com.liferay.portal.model.User findByUuid_First( 155 java.lang.String uuid, 156 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 157 throws com.liferay.portal.NoSuchUserException, 158 com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Returns the first user in the ordered set where uuid = ?. 162 * 163 * @param uuid the uuid 164 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 165 * @return the first matching user, or <code>null</code> if a matching user could not be found 166 * @throws SystemException if a system exception occurred 167 */ 168 public com.liferay.portal.model.User fetchByUuid_First( 169 java.lang.String uuid, 170 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Returns the last user in the ordered set where uuid = ?. 175 * 176 * @param uuid the uuid 177 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 178 * @return the last matching user 179 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 180 * @throws SystemException if a system exception occurred 181 */ 182 public com.liferay.portal.model.User findByUuid_Last( 183 java.lang.String uuid, 184 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 185 throws com.liferay.portal.NoSuchUserException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 /** 189 * Returns the last user in the ordered set where uuid = ?. 190 * 191 * @param uuid the uuid 192 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 193 * @return the last matching user, or <code>null</code> if a matching user could not be found 194 * @throws SystemException if a system exception occurred 195 */ 196 public com.liferay.portal.model.User fetchByUuid_Last( 197 java.lang.String uuid, 198 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 199 throws com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns the users before and after the current user in the ordered set where uuid = ?. 203 * 204 * @param userId the primary key of the current user 205 * @param uuid the uuid 206 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 207 * @return the previous, current, and next user 208 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 209 * @throws SystemException if a system exception occurred 210 */ 211 public com.liferay.portal.model.User[] findByUuid_PrevAndNext(long userId, 212 java.lang.String uuid, 213 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 214 throws com.liferay.portal.NoSuchUserException, 215 com.liferay.portal.kernel.exception.SystemException; 216 217 /** 218 * Returns all the users where uuid = ? and companyId = ?. 219 * 220 * @param uuid the uuid 221 * @param companyId the company ID 222 * @return the matching users 223 * @throws SystemException if a system exception occurred 224 */ 225 public java.util.List<com.liferay.portal.model.User> findByUuid_C( 226 java.lang.String uuid, long companyId) 227 throws com.liferay.portal.kernel.exception.SystemException; 228 229 /** 230 * Returns a range of all the users where uuid = ? and companyId = ?. 231 * 232 * <p> 233 * 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. 234 * </p> 235 * 236 * @param uuid the uuid 237 * @param companyId the company ID 238 * @param start the lower bound of the range of users 239 * @param end the upper bound of the range of users (not inclusive) 240 * @return the range of matching users 241 * @throws SystemException if a system exception occurred 242 */ 243 public java.util.List<com.liferay.portal.model.User> findByUuid_C( 244 java.lang.String uuid, long companyId, int start, int end) 245 throws com.liferay.portal.kernel.exception.SystemException; 246 247 /** 248 * Returns an ordered range of all the users where uuid = ? and companyId = ?. 249 * 250 * <p> 251 * 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. 252 * </p> 253 * 254 * @param uuid the uuid 255 * @param companyId the company ID 256 * @param start the lower bound of the range of users 257 * @param end the upper bound of the range of users (not inclusive) 258 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 259 * @return the ordered range of matching users 260 * @throws SystemException if a system exception occurred 261 */ 262 public java.util.List<com.liferay.portal.model.User> findByUuid_C( 263 java.lang.String uuid, long companyId, int start, int end, 264 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 /** 268 * Returns the first user in the ordered set where uuid = ? and companyId = ?. 269 * 270 * @param uuid the uuid 271 * @param companyId the company ID 272 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 273 * @return the first matching user 274 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 275 * @throws SystemException if a system exception occurred 276 */ 277 public com.liferay.portal.model.User findByUuid_C_First( 278 java.lang.String uuid, long companyId, 279 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 280 throws com.liferay.portal.NoSuchUserException, 281 com.liferay.portal.kernel.exception.SystemException; 282 283 /** 284 * Returns the first user in the ordered set where uuid = ? and companyId = ?. 285 * 286 * @param uuid the uuid 287 * @param companyId the company ID 288 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 289 * @return the first matching user, or <code>null</code> if a matching user could not be found 290 * @throws SystemException if a system exception occurred 291 */ 292 public com.liferay.portal.model.User fetchByUuid_C_First( 293 java.lang.String uuid, long companyId, 294 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 295 throws com.liferay.portal.kernel.exception.SystemException; 296 297 /** 298 * Returns the last user in the ordered set where uuid = ? and companyId = ?. 299 * 300 * @param uuid the uuid 301 * @param companyId the company ID 302 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 303 * @return the last matching user 304 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 305 * @throws SystemException if a system exception occurred 306 */ 307 public com.liferay.portal.model.User findByUuid_C_Last( 308 java.lang.String uuid, long companyId, 309 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 310 throws com.liferay.portal.NoSuchUserException, 311 com.liferay.portal.kernel.exception.SystemException; 312 313 /** 314 * Returns the last user in the ordered set where uuid = ? and companyId = ?. 315 * 316 * @param uuid the uuid 317 * @param companyId the company ID 318 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 319 * @return the last matching user, or <code>null</code> if a matching user could not be found 320 * @throws SystemException if a system exception occurred 321 */ 322 public com.liferay.portal.model.User fetchByUuid_C_Last( 323 java.lang.String uuid, long companyId, 324 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 325 throws com.liferay.portal.kernel.exception.SystemException; 326 327 /** 328 * Returns the users before and after the current user in the ordered set where uuid = ? and companyId = ?. 329 * 330 * @param userId the primary key of the current user 331 * @param uuid the uuid 332 * @param companyId the company ID 333 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 334 * @return the previous, current, and next user 335 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 336 * @throws SystemException if a system exception occurred 337 */ 338 public com.liferay.portal.model.User[] findByUuid_C_PrevAndNext( 339 long userId, java.lang.String uuid, long companyId, 340 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 341 throws com.liferay.portal.NoSuchUserException, 342 com.liferay.portal.kernel.exception.SystemException; 343 344 /** 345 * Returns all the users where companyId = ?. 346 * 347 * @param companyId the company ID 348 * @return the matching users 349 * @throws SystemException if a system exception occurred 350 */ 351 public java.util.List<com.liferay.portal.model.User> findByCompanyId( 352 long companyId) 353 throws com.liferay.portal.kernel.exception.SystemException; 354 355 /** 356 * Returns a range of all the users where companyId = ?. 357 * 358 * <p> 359 * 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. 360 * </p> 361 * 362 * @param companyId the company ID 363 * @param start the lower bound of the range of users 364 * @param end the upper bound of the range of users (not inclusive) 365 * @return the range of matching users 366 * @throws SystemException if a system exception occurred 367 */ 368 public java.util.List<com.liferay.portal.model.User> findByCompanyId( 369 long companyId, int start, int end) 370 throws com.liferay.portal.kernel.exception.SystemException; 371 372 /** 373 * Returns an ordered range of all the users where companyId = ?. 374 * 375 * <p> 376 * 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. 377 * </p> 378 * 379 * @param companyId the company ID 380 * @param start the lower bound of the range of users 381 * @param end the upper bound of the range of users (not inclusive) 382 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 383 * @return the ordered range of matching users 384 * @throws SystemException if a system exception occurred 385 */ 386 public java.util.List<com.liferay.portal.model.User> findByCompanyId( 387 long companyId, int start, int end, 388 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 389 throws com.liferay.portal.kernel.exception.SystemException; 390 391 /** 392 * Returns the first user in the ordered set where companyId = ?. 393 * 394 * @param companyId the company ID 395 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 396 * @return the first matching user 397 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 398 * @throws SystemException if a system exception occurred 399 */ 400 public com.liferay.portal.model.User findByCompanyId_First(long companyId, 401 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 402 throws com.liferay.portal.NoSuchUserException, 403 com.liferay.portal.kernel.exception.SystemException; 404 405 /** 406 * Returns the first user in the ordered set where companyId = ?. 407 * 408 * @param companyId the company ID 409 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 410 * @return the first matching user, or <code>null</code> if a matching user could not be found 411 * @throws SystemException if a system exception occurred 412 */ 413 public com.liferay.portal.model.User fetchByCompanyId_First( 414 long companyId, 415 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 416 throws com.liferay.portal.kernel.exception.SystemException; 417 418 /** 419 * Returns the last user in the ordered set where companyId = ?. 420 * 421 * @param companyId the company ID 422 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 423 * @return the last matching user 424 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 425 * @throws SystemException if a system exception occurred 426 */ 427 public com.liferay.portal.model.User findByCompanyId_Last(long companyId, 428 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 429 throws com.liferay.portal.NoSuchUserException, 430 com.liferay.portal.kernel.exception.SystemException; 431 432 /** 433 * Returns the last user in the ordered set where companyId = ?. 434 * 435 * @param companyId the company ID 436 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 437 * @return the last matching user, or <code>null</code> if a matching user could not be found 438 * @throws SystemException if a system exception occurred 439 */ 440 public com.liferay.portal.model.User fetchByCompanyId_Last(long companyId, 441 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 442 throws com.liferay.portal.kernel.exception.SystemException; 443 444 /** 445 * Returns the users before and after the current user in the ordered set where companyId = ?. 446 * 447 * @param userId the primary key of the current user 448 * @param companyId the company ID 449 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 450 * @return the previous, current, and next user 451 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 452 * @throws SystemException if a system exception occurred 453 */ 454 public com.liferay.portal.model.User[] findByCompanyId_PrevAndNext( 455 long userId, long companyId, 456 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 457 throws com.liferay.portal.NoSuchUserException, 458 com.liferay.portal.kernel.exception.SystemException; 459 460 /** 461 * Returns the user where contactId = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 462 * 463 * @param contactId the contact ID 464 * @return the matching user 465 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 466 * @throws SystemException if a system exception occurred 467 */ 468 public com.liferay.portal.model.User findByContactId(long contactId) 469 throws com.liferay.portal.NoSuchUserException, 470 com.liferay.portal.kernel.exception.SystemException; 471 472 /** 473 * Returns the user where contactId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 474 * 475 * @param contactId the contact ID 476 * @return the matching user, or <code>null</code> if a matching user could not be found 477 * @throws SystemException if a system exception occurred 478 */ 479 public com.liferay.portal.model.User fetchByContactId(long contactId) 480 throws com.liferay.portal.kernel.exception.SystemException; 481 482 /** 483 * Returns the user where contactId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 484 * 485 * @param contactId the contact ID 486 * @param retrieveFromCache whether to use the finder cache 487 * @return the matching user, or <code>null</code> if a matching user could not be found 488 * @throws SystemException if a system exception occurred 489 */ 490 public com.liferay.portal.model.User fetchByContactId(long contactId, 491 boolean retrieveFromCache) 492 throws com.liferay.portal.kernel.exception.SystemException; 493 494 /** 495 * Returns all the users where emailAddress = ?. 496 * 497 * @param emailAddress the email address 498 * @return the matching users 499 * @throws SystemException if a system exception occurred 500 */ 501 public java.util.List<com.liferay.portal.model.User> findByEmailAddress( 502 java.lang.String emailAddress) 503 throws com.liferay.portal.kernel.exception.SystemException; 504 505 /** 506 * Returns a range of all the users where emailAddress = ?. 507 * 508 * <p> 509 * 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. 510 * </p> 511 * 512 * @param emailAddress the email address 513 * @param start the lower bound of the range of users 514 * @param end the upper bound of the range of users (not inclusive) 515 * @return the range of matching users 516 * @throws SystemException if a system exception occurred 517 */ 518 public java.util.List<com.liferay.portal.model.User> findByEmailAddress( 519 java.lang.String emailAddress, int start, int end) 520 throws com.liferay.portal.kernel.exception.SystemException; 521 522 /** 523 * Returns an ordered range of all the users where emailAddress = ?. 524 * 525 * <p> 526 * 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. 527 * </p> 528 * 529 * @param emailAddress the email address 530 * @param start the lower bound of the range of users 531 * @param end the upper bound of the range of users (not inclusive) 532 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 533 * @return the ordered range of matching users 534 * @throws SystemException if a system exception occurred 535 */ 536 public java.util.List<com.liferay.portal.model.User> findByEmailAddress( 537 java.lang.String emailAddress, int start, int end, 538 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 539 throws com.liferay.portal.kernel.exception.SystemException; 540 541 /** 542 * Returns the first user in the ordered set where emailAddress = ?. 543 * 544 * @param emailAddress the email address 545 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 546 * @return the first matching user 547 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 548 * @throws SystemException if a system exception occurred 549 */ 550 public com.liferay.portal.model.User findByEmailAddress_First( 551 java.lang.String emailAddress, 552 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 553 throws com.liferay.portal.NoSuchUserException, 554 com.liferay.portal.kernel.exception.SystemException; 555 556 /** 557 * Returns the first user in the ordered set where emailAddress = ?. 558 * 559 * @param emailAddress the email address 560 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 561 * @return the first matching user, or <code>null</code> if a matching user could not be found 562 * @throws SystemException if a system exception occurred 563 */ 564 public com.liferay.portal.model.User fetchByEmailAddress_First( 565 java.lang.String emailAddress, 566 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 567 throws com.liferay.portal.kernel.exception.SystemException; 568 569 /** 570 * Returns the last user in the ordered set where emailAddress = ?. 571 * 572 * @param emailAddress the email address 573 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 574 * @return the last matching user 575 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 576 * @throws SystemException if a system exception occurred 577 */ 578 public com.liferay.portal.model.User findByEmailAddress_Last( 579 java.lang.String emailAddress, 580 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 581 throws com.liferay.portal.NoSuchUserException, 582 com.liferay.portal.kernel.exception.SystemException; 583 584 /** 585 * Returns the last user in the ordered set where emailAddress = ?. 586 * 587 * @param emailAddress the email address 588 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 589 * @return the last matching user, or <code>null</code> if a matching user could not be found 590 * @throws SystemException if a system exception occurred 591 */ 592 public com.liferay.portal.model.User fetchByEmailAddress_Last( 593 java.lang.String emailAddress, 594 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 595 throws com.liferay.portal.kernel.exception.SystemException; 596 597 /** 598 * Returns the users before and after the current user in the ordered set where emailAddress = ?. 599 * 600 * @param userId the primary key of the current user 601 * @param emailAddress the email address 602 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 603 * @return the previous, current, and next user 604 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 605 * @throws SystemException if a system exception occurred 606 */ 607 public com.liferay.portal.model.User[] findByEmailAddress_PrevAndNext( 608 long userId, java.lang.String emailAddress, 609 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 610 throws com.liferay.portal.NoSuchUserException, 611 com.liferay.portal.kernel.exception.SystemException; 612 613 /** 614 * Returns the user where portraitId = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 615 * 616 * @param portraitId the portrait ID 617 * @return the matching user 618 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 619 * @throws SystemException if a system exception occurred 620 */ 621 public com.liferay.portal.model.User findByPortraitId(long portraitId) 622 throws com.liferay.portal.NoSuchUserException, 623 com.liferay.portal.kernel.exception.SystemException; 624 625 /** 626 * Returns the user where portraitId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 627 * 628 * @param portraitId the portrait ID 629 * @return the matching user, or <code>null</code> if a matching user could not be found 630 * @throws SystemException if a system exception occurred 631 */ 632 public com.liferay.portal.model.User fetchByPortraitId(long portraitId) 633 throws com.liferay.portal.kernel.exception.SystemException; 634 635 /** 636 * Returns the user where portraitId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 637 * 638 * @param portraitId the portrait ID 639 * @param retrieveFromCache whether to use the finder cache 640 * @return the matching user, or <code>null</code> if a matching user could not be found 641 * @throws SystemException if a system exception occurred 642 */ 643 public com.liferay.portal.model.User fetchByPortraitId(long portraitId, 644 boolean retrieveFromCache) 645 throws com.liferay.portal.kernel.exception.SystemException; 646 647 /** 648 * Returns the user where companyId = ? and userId = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 649 * 650 * @param companyId the company ID 651 * @param userId the user ID 652 * @return the matching user 653 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 654 * @throws SystemException if a system exception occurred 655 */ 656 public com.liferay.portal.model.User findByC_U(long companyId, long userId) 657 throws com.liferay.portal.NoSuchUserException, 658 com.liferay.portal.kernel.exception.SystemException; 659 660 /** 661 * Returns the user where companyId = ? and userId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 662 * 663 * @param companyId the company ID 664 * @param userId the user ID 665 * @return the matching user, or <code>null</code> if a matching user could not be found 666 * @throws SystemException if a system exception occurred 667 */ 668 public com.liferay.portal.model.User fetchByC_U(long companyId, long userId) 669 throws com.liferay.portal.kernel.exception.SystemException; 670 671 /** 672 * Returns the user where companyId = ? and userId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 673 * 674 * @param companyId the company ID 675 * @param userId the user ID 676 * @param retrieveFromCache whether to use the finder cache 677 * @return the matching user, or <code>null</code> if a matching user could not be found 678 * @throws SystemException if a system exception occurred 679 */ 680 public com.liferay.portal.model.User fetchByC_U(long companyId, 681 long userId, boolean retrieveFromCache) 682 throws com.liferay.portal.kernel.exception.SystemException; 683 684 /** 685 * Returns the user where companyId = ? and defaultUser = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 686 * 687 * @param companyId the company ID 688 * @param defaultUser the default user 689 * @return the matching user 690 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 691 * @throws SystemException if a system exception occurred 692 */ 693 public com.liferay.portal.model.User findByC_DU(long companyId, 694 boolean defaultUser) 695 throws com.liferay.portal.NoSuchUserException, 696 com.liferay.portal.kernel.exception.SystemException; 697 698 /** 699 * Returns the user where companyId = ? and defaultUser = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 700 * 701 * @param companyId the company ID 702 * @param defaultUser the default user 703 * @return the matching user, or <code>null</code> if a matching user could not be found 704 * @throws SystemException if a system exception occurred 705 */ 706 public com.liferay.portal.model.User fetchByC_DU(long companyId, 707 boolean defaultUser) 708 throws com.liferay.portal.kernel.exception.SystemException; 709 710 /** 711 * Returns the user where companyId = ? and defaultUser = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 712 * 713 * @param companyId the company ID 714 * @param defaultUser the default user 715 * @param retrieveFromCache whether to use the finder cache 716 * @return the matching user, or <code>null</code> if a matching user could not be found 717 * @throws SystemException if a system exception occurred 718 */ 719 public com.liferay.portal.model.User fetchByC_DU(long companyId, 720 boolean defaultUser, boolean retrieveFromCache) 721 throws com.liferay.portal.kernel.exception.SystemException; 722 723 /** 724 * Returns the user where companyId = ? and screenName = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 725 * 726 * @param companyId the company ID 727 * @param screenName the screen name 728 * @return the matching user 729 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 730 * @throws SystemException if a system exception occurred 731 */ 732 public com.liferay.portal.model.User findByC_SN(long companyId, 733 java.lang.String screenName) 734 throws com.liferay.portal.NoSuchUserException, 735 com.liferay.portal.kernel.exception.SystemException; 736 737 /** 738 * Returns the user where companyId = ? and screenName = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 739 * 740 * @param companyId the company ID 741 * @param screenName the screen name 742 * @return the matching user, or <code>null</code> if a matching user could not be found 743 * @throws SystemException if a system exception occurred 744 */ 745 public com.liferay.portal.model.User fetchByC_SN(long companyId, 746 java.lang.String screenName) 747 throws com.liferay.portal.kernel.exception.SystemException; 748 749 /** 750 * Returns the user where companyId = ? and screenName = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 751 * 752 * @param companyId the company ID 753 * @param screenName the screen name 754 * @param retrieveFromCache whether to use the finder cache 755 * @return the matching user, or <code>null</code> if a matching user could not be found 756 * @throws SystemException if a system exception occurred 757 */ 758 public com.liferay.portal.model.User fetchByC_SN(long companyId, 759 java.lang.String screenName, boolean retrieveFromCache) 760 throws com.liferay.portal.kernel.exception.SystemException; 761 762 /** 763 * Returns the user where companyId = ? and emailAddress = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 764 * 765 * @param companyId the company ID 766 * @param emailAddress the email address 767 * @return the matching user 768 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 769 * @throws SystemException if a system exception occurred 770 */ 771 public com.liferay.portal.model.User findByC_EA(long companyId, 772 java.lang.String emailAddress) 773 throws com.liferay.portal.NoSuchUserException, 774 com.liferay.portal.kernel.exception.SystemException; 775 776 /** 777 * Returns the user where companyId = ? and emailAddress = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 778 * 779 * @param companyId the company ID 780 * @param emailAddress the email address 781 * @return the matching user, or <code>null</code> if a matching user could not be found 782 * @throws SystemException if a system exception occurred 783 */ 784 public com.liferay.portal.model.User fetchByC_EA(long companyId, 785 java.lang.String emailAddress) 786 throws com.liferay.portal.kernel.exception.SystemException; 787 788 /** 789 * Returns the user where companyId = ? and emailAddress = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 790 * 791 * @param companyId the company ID 792 * @param emailAddress the email address 793 * @param retrieveFromCache whether to use the finder cache 794 * @return the matching user, or <code>null</code> if a matching user could not be found 795 * @throws SystemException if a system exception occurred 796 */ 797 public com.liferay.portal.model.User fetchByC_EA(long companyId, 798 java.lang.String emailAddress, boolean retrieveFromCache) 799 throws com.liferay.portal.kernel.exception.SystemException; 800 801 /** 802 * Returns the user where companyId = ? and facebookId = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 803 * 804 * @param companyId the company ID 805 * @param facebookId the facebook ID 806 * @return the matching user 807 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 808 * @throws SystemException if a system exception occurred 809 */ 810 public com.liferay.portal.model.User findByC_FID(long companyId, 811 long facebookId) 812 throws com.liferay.portal.NoSuchUserException, 813 com.liferay.portal.kernel.exception.SystemException; 814 815 /** 816 * Returns the user where companyId = ? and facebookId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 817 * 818 * @param companyId the company ID 819 * @param facebookId the facebook ID 820 * @return the matching user, or <code>null</code> if a matching user could not be found 821 * @throws SystemException if a system exception occurred 822 */ 823 public com.liferay.portal.model.User fetchByC_FID(long companyId, 824 long facebookId) 825 throws com.liferay.portal.kernel.exception.SystemException; 826 827 /** 828 * Returns the user where companyId = ? and facebookId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 829 * 830 * @param companyId the company ID 831 * @param facebookId the facebook ID 832 * @param retrieveFromCache whether to use the finder cache 833 * @return the matching user, or <code>null</code> if a matching user could not be found 834 * @throws SystemException if a system exception occurred 835 */ 836 public com.liferay.portal.model.User fetchByC_FID(long companyId, 837 long facebookId, boolean retrieveFromCache) 838 throws com.liferay.portal.kernel.exception.SystemException; 839 840 /** 841 * Returns the user where companyId = ? and openId = ? or throws a {@link com.liferay.portal.NoSuchUserException} if it could not be found. 842 * 843 * @param companyId the company ID 844 * @param openId the open ID 845 * @return the matching user 846 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 847 * @throws SystemException if a system exception occurred 848 */ 849 public com.liferay.portal.model.User findByC_O(long companyId, 850 java.lang.String openId) 851 throws com.liferay.portal.NoSuchUserException, 852 com.liferay.portal.kernel.exception.SystemException; 853 854 /** 855 * Returns the user where companyId = ? and openId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 856 * 857 * @param companyId the company ID 858 * @param openId the open ID 859 * @return the matching user, or <code>null</code> if a matching user could not be found 860 * @throws SystemException if a system exception occurred 861 */ 862 public com.liferay.portal.model.User fetchByC_O(long companyId, 863 java.lang.String openId) 864 throws com.liferay.portal.kernel.exception.SystemException; 865 866 /** 867 * Returns the user where companyId = ? and openId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 868 * 869 * @param companyId the company ID 870 * @param openId the open ID 871 * @param retrieveFromCache whether to use the finder cache 872 * @return the matching user, or <code>null</code> if a matching user could not be found 873 * @throws SystemException if a system exception occurred 874 */ 875 public com.liferay.portal.model.User fetchByC_O(long companyId, 876 java.lang.String openId, boolean retrieveFromCache) 877 throws com.liferay.portal.kernel.exception.SystemException; 878 879 /** 880 * Returns all the users where companyId = ? and status = ?. 881 * 882 * @param companyId the company ID 883 * @param status the status 884 * @return the matching users 885 * @throws SystemException if a system exception occurred 886 */ 887 public java.util.List<com.liferay.portal.model.User> findByC_S( 888 long companyId, int status) 889 throws com.liferay.portal.kernel.exception.SystemException; 890 891 /** 892 * Returns a range of all the users where companyId = ? and status = ?. 893 * 894 * <p> 895 * 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. 896 * </p> 897 * 898 * @param companyId the company ID 899 * @param status the status 900 * @param start the lower bound of the range of users 901 * @param end the upper bound of the range of users (not inclusive) 902 * @return the range of matching users 903 * @throws SystemException if a system exception occurred 904 */ 905 public java.util.List<com.liferay.portal.model.User> findByC_S( 906 long companyId, int status, int start, int end) 907 throws com.liferay.portal.kernel.exception.SystemException; 908 909 /** 910 * Returns an ordered range of all the users where companyId = ? and status = ?. 911 * 912 * <p> 913 * 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. 914 * </p> 915 * 916 * @param companyId the company ID 917 * @param status the status 918 * @param start the lower bound of the range of users 919 * @param end the upper bound of the range of users (not inclusive) 920 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 921 * @return the ordered range of matching users 922 * @throws SystemException if a system exception occurred 923 */ 924 public java.util.List<com.liferay.portal.model.User> findByC_S( 925 long companyId, int status, int start, int end, 926 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 927 throws com.liferay.portal.kernel.exception.SystemException; 928 929 /** 930 * Returns the first user in the ordered set where companyId = ? and status = ?. 931 * 932 * @param companyId the company ID 933 * @param status the status 934 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 935 * @return the first matching user 936 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 937 * @throws SystemException if a system exception occurred 938 */ 939 public com.liferay.portal.model.User findByC_S_First(long companyId, 940 int status, 941 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 942 throws com.liferay.portal.NoSuchUserException, 943 com.liferay.portal.kernel.exception.SystemException; 944 945 /** 946 * Returns the first user in the ordered set where companyId = ? and status = ?. 947 * 948 * @param companyId the company ID 949 * @param status the status 950 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 951 * @return the first matching user, or <code>null</code> if a matching user could not be found 952 * @throws SystemException if a system exception occurred 953 */ 954 public com.liferay.portal.model.User fetchByC_S_First(long companyId, 955 int status, 956 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 957 throws com.liferay.portal.kernel.exception.SystemException; 958 959 /** 960 * Returns the last user in the ordered set where companyId = ? and status = ?. 961 * 962 * @param companyId the company ID 963 * @param status the status 964 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 965 * @return the last matching user 966 * @throws com.liferay.portal.NoSuchUserException if a matching user could not be found 967 * @throws SystemException if a system exception occurred 968 */ 969 public com.liferay.portal.model.User findByC_S_Last(long companyId, 970 int status, 971 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 972 throws com.liferay.portal.NoSuchUserException, 973 com.liferay.portal.kernel.exception.SystemException; 974 975 /** 976 * Returns the last user in the ordered set where companyId = ? and status = ?. 977 * 978 * @param companyId the company ID 979 * @param status the status 980 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 981 * @return the last matching user, or <code>null</code> if a matching user could not be found 982 * @throws SystemException if a system exception occurred 983 */ 984 public com.liferay.portal.model.User fetchByC_S_Last(long companyId, 985 int status, 986 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 987 throws com.liferay.portal.kernel.exception.SystemException; 988 989 /** 990 * Returns the users before and after the current user in the ordered set where companyId = ? and status = ?. 991 * 992 * @param userId the primary key of the current user 993 * @param companyId the company ID 994 * @param status the status 995 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 996 * @return the previous, current, and next user 997 * @throws com.liferay.portal.NoSuchUserException if a user with the primary key could not be found 998 * @throws SystemException if a system exception occurred 999 */ 1000 public com.liferay.portal.model.User[] findByC_S_PrevAndNext(long userId, 1001 long companyId, int status, 1002 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1003 throws com.liferay.portal.NoSuchUserException, 1004 com.liferay.portal.kernel.exception.SystemException; 1005 1006 /** 1007 * Returns all the users. 1008 * 1009 * @return the users 1010 * @throws SystemException if a system exception occurred 1011 */ 1012 public java.util.List<com.liferay.portal.model.User> findAll() 1013 throws com.liferay.portal.kernel.exception.SystemException; 1014 1015 /** 1016 * Returns a range of all the users. 1017 * 1018 * <p> 1019 * 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. 1020 * </p> 1021 * 1022 * @param start the lower bound of the range of users 1023 * @param end the upper bound of the range of users (not inclusive) 1024 * @return the range of users 1025 * @throws SystemException if a system exception occurred 1026 */ 1027 public java.util.List<com.liferay.portal.model.User> findAll(int start, 1028 int end) throws com.liferay.portal.kernel.exception.SystemException; 1029 1030 /** 1031 * Returns an ordered range of all the users. 1032 * 1033 * <p> 1034 * 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. 1035 * </p> 1036 * 1037 * @param start the lower bound of the range of users 1038 * @param end the upper bound of the range of users (not inclusive) 1039 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1040 * @return the ordered range of users 1041 * @throws SystemException if a system exception occurred 1042 */ 1043 public java.util.List<com.liferay.portal.model.User> findAll(int start, 1044 int end, 1045 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1046 throws com.liferay.portal.kernel.exception.SystemException; 1047 1048 /** 1049 * Removes all the users where uuid = ? from the database. 1050 * 1051 * @param uuid the uuid 1052 * @throws SystemException if a system exception occurred 1053 */ 1054 public void removeByUuid(java.lang.String uuid) 1055 throws com.liferay.portal.kernel.exception.SystemException; 1056 1057 /** 1058 * Removes all the users where uuid = ? and companyId = ? from the database. 1059 * 1060 * @param uuid the uuid 1061 * @param companyId the company ID 1062 * @throws SystemException if a system exception occurred 1063 */ 1064 public void removeByUuid_C(java.lang.String uuid, long companyId) 1065 throws com.liferay.portal.kernel.exception.SystemException; 1066 1067 /** 1068 * Removes all the users where companyId = ? from the database. 1069 * 1070 * @param companyId the company ID 1071 * @throws SystemException if a system exception occurred 1072 */ 1073 public void removeByCompanyId(long companyId) 1074 throws com.liferay.portal.kernel.exception.SystemException; 1075 1076 /** 1077 * Removes the user where contactId = ? from the database. 1078 * 1079 * @param contactId the contact ID 1080 * @return the user that was removed 1081 * @throws SystemException if a system exception occurred 1082 */ 1083 public com.liferay.portal.model.User removeByContactId(long contactId) 1084 throws com.liferay.portal.NoSuchUserException, 1085 com.liferay.portal.kernel.exception.SystemException; 1086 1087 /** 1088 * Removes all the users where emailAddress = ? from the database. 1089 * 1090 * @param emailAddress the email address 1091 * @throws SystemException if a system exception occurred 1092 */ 1093 public void removeByEmailAddress(java.lang.String emailAddress) 1094 throws com.liferay.portal.kernel.exception.SystemException; 1095 1096 /** 1097 * Removes the user where portraitId = ? from the database. 1098 * 1099 * @param portraitId the portrait ID 1100 * @return the user that was removed 1101 * @throws SystemException if a system exception occurred 1102 */ 1103 public com.liferay.portal.model.User removeByPortraitId(long portraitId) 1104 throws com.liferay.portal.NoSuchUserException, 1105 com.liferay.portal.kernel.exception.SystemException; 1106 1107 /** 1108 * Removes the user where companyId = ? and userId = ? from the database. 1109 * 1110 * @param companyId the company ID 1111 * @param userId the user ID 1112 * @return the user that was removed 1113 * @throws SystemException if a system exception occurred 1114 */ 1115 public com.liferay.portal.model.User removeByC_U(long companyId, long userId) 1116 throws com.liferay.portal.NoSuchUserException, 1117 com.liferay.portal.kernel.exception.SystemException; 1118 1119 /** 1120 * Removes the user where companyId = ? and defaultUser = ? from the database. 1121 * 1122 * @param companyId the company ID 1123 * @param defaultUser the default user 1124 * @return the user that was removed 1125 * @throws SystemException if a system exception occurred 1126 */ 1127 public com.liferay.portal.model.User removeByC_DU(long companyId, 1128 boolean defaultUser) 1129 throws com.liferay.portal.NoSuchUserException, 1130 com.liferay.portal.kernel.exception.SystemException; 1131 1132 /** 1133 * Removes the user where companyId = ? and screenName = ? from the database. 1134 * 1135 * @param companyId the company ID 1136 * @param screenName the screen name 1137 * @return the user that was removed 1138 * @throws SystemException if a system exception occurred 1139 */ 1140 public com.liferay.portal.model.User removeByC_SN(long companyId, 1141 java.lang.String screenName) 1142 throws com.liferay.portal.NoSuchUserException, 1143 com.liferay.portal.kernel.exception.SystemException; 1144 1145 /** 1146 * Removes the user where companyId = ? and emailAddress = ? from the database. 1147 * 1148 * @param companyId the company ID 1149 * @param emailAddress the email address 1150 * @return the user that was removed 1151 * @throws SystemException if a system exception occurred 1152 */ 1153 public com.liferay.portal.model.User removeByC_EA(long companyId, 1154 java.lang.String emailAddress) 1155 throws com.liferay.portal.NoSuchUserException, 1156 com.liferay.portal.kernel.exception.SystemException; 1157 1158 /** 1159 * Removes the user where companyId = ? and facebookId = ? from the database. 1160 * 1161 * @param companyId the company ID 1162 * @param facebookId the facebook ID 1163 * @return the user that was removed 1164 * @throws SystemException if a system exception occurred 1165 */ 1166 public com.liferay.portal.model.User removeByC_FID(long companyId, 1167 long facebookId) 1168 throws com.liferay.portal.NoSuchUserException, 1169 com.liferay.portal.kernel.exception.SystemException; 1170 1171 /** 1172 * Removes the user where companyId = ? and openId = ? from the database. 1173 * 1174 * @param companyId the company ID 1175 * @param openId the open ID 1176 * @return the user that was removed 1177 * @throws SystemException if a system exception occurred 1178 */ 1179 public com.liferay.portal.model.User removeByC_O(long companyId, 1180 java.lang.String openId) 1181 throws com.liferay.portal.NoSuchUserException, 1182 com.liferay.portal.kernel.exception.SystemException; 1183 1184 /** 1185 * Removes all the users where companyId = ? and status = ? from the database. 1186 * 1187 * @param companyId the company ID 1188 * @param status the status 1189 * @throws SystemException if a system exception occurred 1190 */ 1191 public void removeByC_S(long companyId, int status) 1192 throws com.liferay.portal.kernel.exception.SystemException; 1193 1194 /** 1195 * Removes all the users from the database. 1196 * 1197 * @throws SystemException if a system exception occurred 1198 */ 1199 public void removeAll() 1200 throws com.liferay.portal.kernel.exception.SystemException; 1201 1202 /** 1203 * Returns the number of users where uuid = ?. 1204 * 1205 * @param uuid the uuid 1206 * @return the number of matching users 1207 * @throws SystemException if a system exception occurred 1208 */ 1209 public int countByUuid(java.lang.String uuid) 1210 throws com.liferay.portal.kernel.exception.SystemException; 1211 1212 /** 1213 * Returns the number of users where uuid = ? and companyId = ?. 1214 * 1215 * @param uuid the uuid 1216 * @param companyId the company ID 1217 * @return the number of matching users 1218 * @throws SystemException if a system exception occurred 1219 */ 1220 public int countByUuid_C(java.lang.String uuid, long companyId) 1221 throws com.liferay.portal.kernel.exception.SystemException; 1222 1223 /** 1224 * Returns the number of users where companyId = ?. 1225 * 1226 * @param companyId the company ID 1227 * @return the number of matching users 1228 * @throws SystemException if a system exception occurred 1229 */ 1230 public int countByCompanyId(long companyId) 1231 throws com.liferay.portal.kernel.exception.SystemException; 1232 1233 /** 1234 * Returns the number of users where contactId = ?. 1235 * 1236 * @param contactId the contact ID 1237 * @return the number of matching users 1238 * @throws SystemException if a system exception occurred 1239 */ 1240 public int countByContactId(long contactId) 1241 throws com.liferay.portal.kernel.exception.SystemException; 1242 1243 /** 1244 * Returns the number of users where emailAddress = ?. 1245 * 1246 * @param emailAddress the email address 1247 * @return the number of matching users 1248 * @throws SystemException if a system exception occurred 1249 */ 1250 public int countByEmailAddress(java.lang.String emailAddress) 1251 throws com.liferay.portal.kernel.exception.SystemException; 1252 1253 /** 1254 * Returns the number of users where portraitId = ?. 1255 * 1256 * @param portraitId the portrait ID 1257 * @return the number of matching users 1258 * @throws SystemException if a system exception occurred 1259 */ 1260 public int countByPortraitId(long portraitId) 1261 throws com.liferay.portal.kernel.exception.SystemException; 1262 1263 /** 1264 * Returns the number of users where companyId = ? and userId = ?. 1265 * 1266 * @param companyId the company ID 1267 * @param userId the user ID 1268 * @return the number of matching users 1269 * @throws SystemException if a system exception occurred 1270 */ 1271 public int countByC_U(long companyId, long userId) 1272 throws com.liferay.portal.kernel.exception.SystemException; 1273 1274 /** 1275 * Returns the number of users where companyId = ? and defaultUser = ?. 1276 * 1277 * @param companyId the company ID 1278 * @param defaultUser the default user 1279 * @return the number of matching users 1280 * @throws SystemException if a system exception occurred 1281 */ 1282 public int countByC_DU(long companyId, boolean defaultUser) 1283 throws com.liferay.portal.kernel.exception.SystemException; 1284 1285 /** 1286 * Returns the number of users where companyId = ? and screenName = ?. 1287 * 1288 * @param companyId the company ID 1289 * @param screenName the screen name 1290 * @return the number of matching users 1291 * @throws SystemException if a system exception occurred 1292 */ 1293 public int countByC_SN(long companyId, java.lang.String screenName) 1294 throws com.liferay.portal.kernel.exception.SystemException; 1295 1296 /** 1297 * Returns the number of users where companyId = ? and emailAddress = ?. 1298 * 1299 * @param companyId the company ID 1300 * @param emailAddress the email address 1301 * @return the number of matching users 1302 * @throws SystemException if a system exception occurred 1303 */ 1304 public int countByC_EA(long companyId, java.lang.String emailAddress) 1305 throws com.liferay.portal.kernel.exception.SystemException; 1306 1307 /** 1308 * Returns the number of users where companyId = ? and facebookId = ?. 1309 * 1310 * @param companyId the company ID 1311 * @param facebookId the facebook ID 1312 * @return the number of matching users 1313 * @throws SystemException if a system exception occurred 1314 */ 1315 public int countByC_FID(long companyId, long facebookId) 1316 throws com.liferay.portal.kernel.exception.SystemException; 1317 1318 /** 1319 * Returns the number of users where companyId = ? and openId = ?. 1320 * 1321 * @param companyId the company ID 1322 * @param openId the open ID 1323 * @return the number of matching users 1324 * @throws SystemException if a system exception occurred 1325 */ 1326 public int countByC_O(long companyId, java.lang.String openId) 1327 throws com.liferay.portal.kernel.exception.SystemException; 1328 1329 /** 1330 * Returns the number of users where companyId = ? and status = ?. 1331 * 1332 * @param companyId the company ID 1333 * @param status the status 1334 * @return the number of matching users 1335 * @throws SystemException if a system exception occurred 1336 */ 1337 public int countByC_S(long companyId, int status) 1338 throws com.liferay.portal.kernel.exception.SystemException; 1339 1340 /** 1341 * Returns the number of users. 1342 * 1343 * @return the number of users 1344 * @throws SystemException if a system exception occurred 1345 */ 1346 public int countAll() 1347 throws com.liferay.portal.kernel.exception.SystemException; 1348 1349 /** 1350 * Returns all the groups associated with the user. 1351 * 1352 * @param pk the primary key of the user 1353 * @return the groups associated with the user 1354 * @throws SystemException if a system exception occurred 1355 */ 1356 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk) 1357 throws com.liferay.portal.kernel.exception.SystemException; 1358 1359 /** 1360 * Returns a range of all the groups associated with the user. 1361 * 1362 * <p> 1363 * 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. 1364 * </p> 1365 * 1366 * @param pk the primary key of the user 1367 * @param start the lower bound of the range of users 1368 * @param end the upper bound of the range of users (not inclusive) 1369 * @return the range of groups associated with the user 1370 * @throws SystemException if a system exception occurred 1371 */ 1372 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk, 1373 int start, int end) 1374 throws com.liferay.portal.kernel.exception.SystemException; 1375 1376 /** 1377 * Returns an ordered range of all the groups associated with the user. 1378 * 1379 * <p> 1380 * 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. 1381 * </p> 1382 * 1383 * @param pk the primary key of the user 1384 * @param start the lower bound of the range of users 1385 * @param end the upper bound of the range of users (not inclusive) 1386 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1387 * @return the ordered range of groups associated with the user 1388 * @throws SystemException if a system exception occurred 1389 */ 1390 public java.util.List<com.liferay.portal.model.Group> getGroups(long pk, 1391 int start, int end, 1392 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1393 throws com.liferay.portal.kernel.exception.SystemException; 1394 1395 /** 1396 * Returns the number of groups associated with the user. 1397 * 1398 * @param pk the primary key of the user 1399 * @return the number of groups associated with the user 1400 * @throws SystemException if a system exception occurred 1401 */ 1402 public int getGroupsSize(long pk) 1403 throws com.liferay.portal.kernel.exception.SystemException; 1404 1405 /** 1406 * Returns <code>true</code> if the group is associated with the user. 1407 * 1408 * @param pk the primary key of the user 1409 * @param groupPK the primary key of the group 1410 * @return <code>true</code> if the group is associated with the user; <code>false</code> otherwise 1411 * @throws SystemException if a system exception occurred 1412 */ 1413 public boolean containsGroup(long pk, long groupPK) 1414 throws com.liferay.portal.kernel.exception.SystemException; 1415 1416 /** 1417 * Returns <code>true</code> if the user has any groups associated with it. 1418 * 1419 * @param pk the primary key of the user to check for associations with groups 1420 * @return <code>true</code> if the user has any groups associated with it; <code>false</code> otherwise 1421 * @throws SystemException if a system exception occurred 1422 */ 1423 public boolean containsGroups(long pk) 1424 throws com.liferay.portal.kernel.exception.SystemException; 1425 1426 /** 1427 * Adds an association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1428 * 1429 * @param pk the primary key of the user 1430 * @param groupPK the primary key of the group 1431 * @throws SystemException if a system exception occurred 1432 */ 1433 public void addGroup(long pk, long groupPK) 1434 throws com.liferay.portal.kernel.exception.SystemException; 1435 1436 /** 1437 * Adds an association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1438 * 1439 * @param pk the primary key of the user 1440 * @param group the group 1441 * @throws SystemException if a system exception occurred 1442 */ 1443 public void addGroup(long pk, com.liferay.portal.model.Group group) 1444 throws com.liferay.portal.kernel.exception.SystemException; 1445 1446 /** 1447 * Adds an association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1448 * 1449 * @param pk the primary key of the user 1450 * @param groupPKs the primary keys of the groups 1451 * @throws SystemException if a system exception occurred 1452 */ 1453 public void addGroups(long pk, long[] groupPKs) 1454 throws com.liferay.portal.kernel.exception.SystemException; 1455 1456 /** 1457 * Adds an association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1458 * 1459 * @param pk the primary key of the user 1460 * @param groups the groups 1461 * @throws SystemException if a system exception occurred 1462 */ 1463 public void addGroups(long pk, 1464 java.util.List<com.liferay.portal.model.Group> groups) 1465 throws com.liferay.portal.kernel.exception.SystemException; 1466 1467 /** 1468 * Clears all associations between the user and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1469 * 1470 * @param pk the primary key of the user to clear the associated groups from 1471 * @throws SystemException if a system exception occurred 1472 */ 1473 public void clearGroups(long pk) 1474 throws com.liferay.portal.kernel.exception.SystemException; 1475 1476 /** 1477 * Removes the association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1478 * 1479 * @param pk the primary key of the user 1480 * @param groupPK the primary key of the group 1481 * @throws SystemException if a system exception occurred 1482 */ 1483 public void removeGroup(long pk, long groupPK) 1484 throws com.liferay.portal.kernel.exception.SystemException; 1485 1486 /** 1487 * Removes the association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1488 * 1489 * @param pk the primary key of the user 1490 * @param group the group 1491 * @throws SystemException if a system exception occurred 1492 */ 1493 public void removeGroup(long pk, com.liferay.portal.model.Group group) 1494 throws com.liferay.portal.kernel.exception.SystemException; 1495 1496 /** 1497 * Removes the association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1498 * 1499 * @param pk the primary key of the user 1500 * @param groupPKs the primary keys of the groups 1501 * @throws SystemException if a system exception occurred 1502 */ 1503 public void removeGroups(long pk, long[] groupPKs) 1504 throws com.liferay.portal.kernel.exception.SystemException; 1505 1506 /** 1507 * Removes the association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1508 * 1509 * @param pk the primary key of the user 1510 * @param groups the groups 1511 * @throws SystemException if a system exception occurred 1512 */ 1513 public void removeGroups(long pk, 1514 java.util.List<com.liferay.portal.model.Group> groups) 1515 throws com.liferay.portal.kernel.exception.SystemException; 1516 1517 /** 1518 * Sets the groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1519 * 1520 * @param pk the primary key of the user 1521 * @param groupPKs the primary keys of the groups to be associated with the user 1522 * @throws SystemException if a system exception occurred 1523 */ 1524 public void setGroups(long pk, long[] groupPKs) 1525 throws com.liferay.portal.kernel.exception.SystemException; 1526 1527 /** 1528 * Sets the groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1529 * 1530 * @param pk the primary key of the user 1531 * @param groups the groups to be associated with the user 1532 * @throws SystemException if a system exception occurred 1533 */ 1534 public void setGroups(long pk, 1535 java.util.List<com.liferay.portal.model.Group> groups) 1536 throws com.liferay.portal.kernel.exception.SystemException; 1537 1538 /** 1539 * Returns all the organizations associated with the user. 1540 * 1541 * @param pk the primary key of the user 1542 * @return the organizations associated with the user 1543 * @throws SystemException if a system exception occurred 1544 */ 1545 public java.util.List<com.liferay.portal.model.Organization> getOrganizations( 1546 long pk) throws com.liferay.portal.kernel.exception.SystemException; 1547 1548 /** 1549 * Returns a range of all the organizations associated with the user. 1550 * 1551 * <p> 1552 * 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. 1553 * </p> 1554 * 1555 * @param pk the primary key of the user 1556 * @param start the lower bound of the range of users 1557 * @param end the upper bound of the range of users (not inclusive) 1558 * @return the range of organizations associated with the user 1559 * @throws SystemException if a system exception occurred 1560 */ 1561 public java.util.List<com.liferay.portal.model.Organization> getOrganizations( 1562 long pk, int start, int end) 1563 throws com.liferay.portal.kernel.exception.SystemException; 1564 1565 /** 1566 * Returns an ordered range of all the organizations associated with the user. 1567 * 1568 * <p> 1569 * 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. 1570 * </p> 1571 * 1572 * @param pk the primary key of the user 1573 * @param start the lower bound of the range of users 1574 * @param end the upper bound of the range of users (not inclusive) 1575 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1576 * @return the ordered range of organizations associated with the user 1577 * @throws SystemException if a system exception occurred 1578 */ 1579 public java.util.List<com.liferay.portal.model.Organization> getOrganizations( 1580 long pk, int start, int end, 1581 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1582 throws com.liferay.portal.kernel.exception.SystemException; 1583 1584 /** 1585 * Returns the number of organizations associated with the user. 1586 * 1587 * @param pk the primary key of the user 1588 * @return the number of organizations associated with the user 1589 * @throws SystemException if a system exception occurred 1590 */ 1591 public int getOrganizationsSize(long pk) 1592 throws com.liferay.portal.kernel.exception.SystemException; 1593 1594 /** 1595 * Returns <code>true</code> if the organization is associated with the user. 1596 * 1597 * @param pk the primary key of the user 1598 * @param organizationPK the primary key of the organization 1599 * @return <code>true</code> if the organization is associated with the user; <code>false</code> otherwise 1600 * @throws SystemException if a system exception occurred 1601 */ 1602 public boolean containsOrganization(long pk, long organizationPK) 1603 throws com.liferay.portal.kernel.exception.SystemException; 1604 1605 /** 1606 * Returns <code>true</code> if the user has any organizations associated with it. 1607 * 1608 * @param pk the primary key of the user to check for associations with organizations 1609 * @return <code>true</code> if the user has any organizations associated with it; <code>false</code> otherwise 1610 * @throws SystemException if a system exception occurred 1611 */ 1612 public boolean containsOrganizations(long pk) 1613 throws com.liferay.portal.kernel.exception.SystemException; 1614 1615 /** 1616 * Adds an association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1617 * 1618 * @param pk the primary key of the user 1619 * @param organizationPK the primary key of the organization 1620 * @throws SystemException if a system exception occurred 1621 */ 1622 public void addOrganization(long pk, long organizationPK) 1623 throws com.liferay.portal.kernel.exception.SystemException; 1624 1625 /** 1626 * Adds an association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1627 * 1628 * @param pk the primary key of the user 1629 * @param organization the organization 1630 * @throws SystemException if a system exception occurred 1631 */ 1632 public void addOrganization(long pk, 1633 com.liferay.portal.model.Organization organization) 1634 throws com.liferay.portal.kernel.exception.SystemException; 1635 1636 /** 1637 * Adds an association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1638 * 1639 * @param pk the primary key of the user 1640 * @param organizationPKs the primary keys of the organizations 1641 * @throws SystemException if a system exception occurred 1642 */ 1643 public void addOrganizations(long pk, long[] organizationPKs) 1644 throws com.liferay.portal.kernel.exception.SystemException; 1645 1646 /** 1647 * Adds an association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1648 * 1649 * @param pk the primary key of the user 1650 * @param organizations the organizations 1651 * @throws SystemException if a system exception occurred 1652 */ 1653 public void addOrganizations(long pk, 1654 java.util.List<com.liferay.portal.model.Organization> organizations) 1655 throws com.liferay.portal.kernel.exception.SystemException; 1656 1657 /** 1658 * Clears all associations between the user and its organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1659 * 1660 * @param pk the primary key of the user to clear the associated organizations from 1661 * @throws SystemException if a system exception occurred 1662 */ 1663 public void clearOrganizations(long pk) 1664 throws com.liferay.portal.kernel.exception.SystemException; 1665 1666 /** 1667 * Removes the association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1668 * 1669 * @param pk the primary key of the user 1670 * @param organizationPK the primary key of the organization 1671 * @throws SystemException if a system exception occurred 1672 */ 1673 public void removeOrganization(long pk, long organizationPK) 1674 throws com.liferay.portal.kernel.exception.SystemException; 1675 1676 /** 1677 * Removes the association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1678 * 1679 * @param pk the primary key of the user 1680 * @param organization the organization 1681 * @throws SystemException if a system exception occurred 1682 */ 1683 public void removeOrganization(long pk, 1684 com.liferay.portal.model.Organization organization) 1685 throws com.liferay.portal.kernel.exception.SystemException; 1686 1687 /** 1688 * Removes the association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1689 * 1690 * @param pk the primary key of the user 1691 * @param organizationPKs the primary keys of the organizations 1692 * @throws SystemException if a system exception occurred 1693 */ 1694 public void removeOrganizations(long pk, long[] organizationPKs) 1695 throws com.liferay.portal.kernel.exception.SystemException; 1696 1697 /** 1698 * Removes the association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1699 * 1700 * @param pk the primary key of the user 1701 * @param organizations the organizations 1702 * @throws SystemException if a system exception occurred 1703 */ 1704 public void removeOrganizations(long pk, 1705 java.util.List<com.liferay.portal.model.Organization> organizations) 1706 throws com.liferay.portal.kernel.exception.SystemException; 1707 1708 /** 1709 * Sets the organizations associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1710 * 1711 * @param pk the primary key of the user 1712 * @param organizationPKs the primary keys of the organizations to be associated with the user 1713 * @throws SystemException if a system exception occurred 1714 */ 1715 public void setOrganizations(long pk, long[] organizationPKs) 1716 throws com.liferay.portal.kernel.exception.SystemException; 1717 1718 /** 1719 * Sets the organizations associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1720 * 1721 * @param pk the primary key of the user 1722 * @param organizations the organizations to be associated with the user 1723 * @throws SystemException if a system exception occurred 1724 */ 1725 public void setOrganizations(long pk, 1726 java.util.List<com.liferay.portal.model.Organization> organizations) 1727 throws com.liferay.portal.kernel.exception.SystemException; 1728 1729 /** 1730 * Returns all the roles associated with the user. 1731 * 1732 * @param pk the primary key of the user 1733 * @return the roles associated with the user 1734 * @throws SystemException if a system exception occurred 1735 */ 1736 public java.util.List<com.liferay.portal.model.Role> getRoles(long pk) 1737 throws com.liferay.portal.kernel.exception.SystemException; 1738 1739 /** 1740 * Returns a range of all the roles associated with the user. 1741 * 1742 * <p> 1743 * 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. 1744 * </p> 1745 * 1746 * @param pk the primary key of the user 1747 * @param start the lower bound of the range of users 1748 * @param end the upper bound of the range of users (not inclusive) 1749 * @return the range of roles associated with the user 1750 * @throws SystemException if a system exception occurred 1751 */ 1752 public java.util.List<com.liferay.portal.model.Role> getRoles(long pk, 1753 int start, int end) 1754 throws com.liferay.portal.kernel.exception.SystemException; 1755 1756 /** 1757 * Returns an ordered range of all the roles associated with the user. 1758 * 1759 * <p> 1760 * 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. 1761 * </p> 1762 * 1763 * @param pk the primary key of the user 1764 * @param start the lower bound of the range of users 1765 * @param end the upper bound of the range of users (not inclusive) 1766 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1767 * @return the ordered range of roles associated with the user 1768 * @throws SystemException if a system exception occurred 1769 */ 1770 public java.util.List<com.liferay.portal.model.Role> getRoles(long pk, 1771 int start, int end, 1772 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1773 throws com.liferay.portal.kernel.exception.SystemException; 1774 1775 /** 1776 * Returns the number of roles associated with the user. 1777 * 1778 * @param pk the primary key of the user 1779 * @return the number of roles associated with the user 1780 * @throws SystemException if a system exception occurred 1781 */ 1782 public int getRolesSize(long pk) 1783 throws com.liferay.portal.kernel.exception.SystemException; 1784 1785 /** 1786 * Returns <code>true</code> if the role is associated with the user. 1787 * 1788 * @param pk the primary key of the user 1789 * @param rolePK the primary key of the role 1790 * @return <code>true</code> if the role is associated with the user; <code>false</code> otherwise 1791 * @throws SystemException if a system exception occurred 1792 */ 1793 public boolean containsRole(long pk, long rolePK) 1794 throws com.liferay.portal.kernel.exception.SystemException; 1795 1796 /** 1797 * Returns <code>true</code> if the user has any roles associated with it. 1798 * 1799 * @param pk the primary key of the user to check for associations with roles 1800 * @return <code>true</code> if the user has any roles associated with it; <code>false</code> otherwise 1801 * @throws SystemException if a system exception occurred 1802 */ 1803 public boolean containsRoles(long pk) 1804 throws com.liferay.portal.kernel.exception.SystemException; 1805 1806 /** 1807 * Adds an association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1808 * 1809 * @param pk the primary key of the user 1810 * @param rolePK the primary key of the role 1811 * @throws SystemException if a system exception occurred 1812 */ 1813 public void addRole(long pk, long rolePK) 1814 throws com.liferay.portal.kernel.exception.SystemException; 1815 1816 /** 1817 * Adds an association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1818 * 1819 * @param pk the primary key of the user 1820 * @param role the role 1821 * @throws SystemException if a system exception occurred 1822 */ 1823 public void addRole(long pk, com.liferay.portal.model.Role role) 1824 throws com.liferay.portal.kernel.exception.SystemException; 1825 1826 /** 1827 * Adds an association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1828 * 1829 * @param pk the primary key of the user 1830 * @param rolePKs the primary keys of the roles 1831 * @throws SystemException if a system exception occurred 1832 */ 1833 public void addRoles(long pk, long[] rolePKs) 1834 throws com.liferay.portal.kernel.exception.SystemException; 1835 1836 /** 1837 * Adds an association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1838 * 1839 * @param pk the primary key of the user 1840 * @param roles the roles 1841 * @throws SystemException if a system exception occurred 1842 */ 1843 public void addRoles(long pk, 1844 java.util.List<com.liferay.portal.model.Role> roles) 1845 throws com.liferay.portal.kernel.exception.SystemException; 1846 1847 /** 1848 * Clears all associations between the user and its roles. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1849 * 1850 * @param pk the primary key of the user to clear the associated roles from 1851 * @throws SystemException if a system exception occurred 1852 */ 1853 public void clearRoles(long pk) 1854 throws com.liferay.portal.kernel.exception.SystemException; 1855 1856 /** 1857 * Removes the association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1858 * 1859 * @param pk the primary key of the user 1860 * @param rolePK the primary key of the role 1861 * @throws SystemException if a system exception occurred 1862 */ 1863 public void removeRole(long pk, long rolePK) 1864 throws com.liferay.portal.kernel.exception.SystemException; 1865 1866 /** 1867 * Removes the association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1868 * 1869 * @param pk the primary key of the user 1870 * @param role the role 1871 * @throws SystemException if a system exception occurred 1872 */ 1873 public void removeRole(long pk, com.liferay.portal.model.Role role) 1874 throws com.liferay.portal.kernel.exception.SystemException; 1875 1876 /** 1877 * Removes the association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1878 * 1879 * @param pk the primary key of the user 1880 * @param rolePKs the primary keys of the roles 1881 * @throws SystemException if a system exception occurred 1882 */ 1883 public void removeRoles(long pk, long[] rolePKs) 1884 throws com.liferay.portal.kernel.exception.SystemException; 1885 1886 /** 1887 * Removes the association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1888 * 1889 * @param pk the primary key of the user 1890 * @param roles the roles 1891 * @throws SystemException if a system exception occurred 1892 */ 1893 public void removeRoles(long pk, 1894 java.util.List<com.liferay.portal.model.Role> roles) 1895 throws com.liferay.portal.kernel.exception.SystemException; 1896 1897 /** 1898 * Sets the roles associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1899 * 1900 * @param pk the primary key of the user 1901 * @param rolePKs the primary keys of the roles to be associated with the user 1902 * @throws SystemException if a system exception occurred 1903 */ 1904 public void setRoles(long pk, long[] rolePKs) 1905 throws com.liferay.portal.kernel.exception.SystemException; 1906 1907 /** 1908 * Sets the roles associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1909 * 1910 * @param pk the primary key of the user 1911 * @param roles the roles to be associated with the user 1912 * @throws SystemException if a system exception occurred 1913 */ 1914 public void setRoles(long pk, 1915 java.util.List<com.liferay.portal.model.Role> roles) 1916 throws com.liferay.portal.kernel.exception.SystemException; 1917 1918 /** 1919 * Returns all the teams associated with the user. 1920 * 1921 * @param pk the primary key of the user 1922 * @return the teams associated with the user 1923 * @throws SystemException if a system exception occurred 1924 */ 1925 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk) 1926 throws com.liferay.portal.kernel.exception.SystemException; 1927 1928 /** 1929 * Returns a range of all the teams associated with the user. 1930 * 1931 * <p> 1932 * 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. 1933 * </p> 1934 * 1935 * @param pk the primary key of the user 1936 * @param start the lower bound of the range of users 1937 * @param end the upper bound of the range of users (not inclusive) 1938 * @return the range of teams associated with the user 1939 * @throws SystemException if a system exception occurred 1940 */ 1941 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk, 1942 int start, int end) 1943 throws com.liferay.portal.kernel.exception.SystemException; 1944 1945 /** 1946 * Returns an ordered range of all the teams associated with the user. 1947 * 1948 * <p> 1949 * 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. 1950 * </p> 1951 * 1952 * @param pk the primary key of the user 1953 * @param start the lower bound of the range of users 1954 * @param end the upper bound of the range of users (not inclusive) 1955 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1956 * @return the ordered range of teams associated with the user 1957 * @throws SystemException if a system exception occurred 1958 */ 1959 public java.util.List<com.liferay.portal.model.Team> getTeams(long pk, 1960 int start, int end, 1961 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1962 throws com.liferay.portal.kernel.exception.SystemException; 1963 1964 /** 1965 * Returns the number of teams associated with the user. 1966 * 1967 * @param pk the primary key of the user 1968 * @return the number of teams associated with the user 1969 * @throws SystemException if a system exception occurred 1970 */ 1971 public int getTeamsSize(long pk) 1972 throws com.liferay.portal.kernel.exception.SystemException; 1973 1974 /** 1975 * Returns <code>true</code> if the team is associated with the user. 1976 * 1977 * @param pk the primary key of the user 1978 * @param teamPK the primary key of the team 1979 * @return <code>true</code> if the team is associated with the user; <code>false</code> otherwise 1980 * @throws SystemException if a system exception occurred 1981 */ 1982 public boolean containsTeam(long pk, long teamPK) 1983 throws com.liferay.portal.kernel.exception.SystemException; 1984 1985 /** 1986 * Returns <code>true</code> if the user has any teams associated with it. 1987 * 1988 * @param pk the primary key of the user to check for associations with teams 1989 * @return <code>true</code> if the user has any teams associated with it; <code>false</code> otherwise 1990 * @throws SystemException if a system exception occurred 1991 */ 1992 public boolean containsTeams(long pk) 1993 throws com.liferay.portal.kernel.exception.SystemException; 1994 1995 /** 1996 * Adds an association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 1997 * 1998 * @param pk the primary key of the user 1999 * @param teamPK the primary key of the team 2000 * @throws SystemException if a system exception occurred 2001 */ 2002 public void addTeam(long pk, long teamPK) 2003 throws com.liferay.portal.kernel.exception.SystemException; 2004 2005 /** 2006 * Adds an association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2007 * 2008 * @param pk the primary key of the user 2009 * @param team the team 2010 * @throws SystemException if a system exception occurred 2011 */ 2012 public void addTeam(long pk, com.liferay.portal.model.Team team) 2013 throws com.liferay.portal.kernel.exception.SystemException; 2014 2015 /** 2016 * Adds an association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2017 * 2018 * @param pk the primary key of the user 2019 * @param teamPKs the primary keys of the teams 2020 * @throws SystemException if a system exception occurred 2021 */ 2022 public void addTeams(long pk, long[] teamPKs) 2023 throws com.liferay.portal.kernel.exception.SystemException; 2024 2025 /** 2026 * Adds an association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2027 * 2028 * @param pk the primary key of the user 2029 * @param teams the teams 2030 * @throws SystemException if a system exception occurred 2031 */ 2032 public void addTeams(long pk, 2033 java.util.List<com.liferay.portal.model.Team> teams) 2034 throws com.liferay.portal.kernel.exception.SystemException; 2035 2036 /** 2037 * Clears all associations between the user and its teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2038 * 2039 * @param pk the primary key of the user to clear the associated teams from 2040 * @throws SystemException if a system exception occurred 2041 */ 2042 public void clearTeams(long pk) 2043 throws com.liferay.portal.kernel.exception.SystemException; 2044 2045 /** 2046 * Removes the association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2047 * 2048 * @param pk the primary key of the user 2049 * @param teamPK the primary key of the team 2050 * @throws SystemException if a system exception occurred 2051 */ 2052 public void removeTeam(long pk, long teamPK) 2053 throws com.liferay.portal.kernel.exception.SystemException; 2054 2055 /** 2056 * Removes the association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2057 * 2058 * @param pk the primary key of the user 2059 * @param team the team 2060 * @throws SystemException if a system exception occurred 2061 */ 2062 public void removeTeam(long pk, com.liferay.portal.model.Team team) 2063 throws com.liferay.portal.kernel.exception.SystemException; 2064 2065 /** 2066 * Removes the association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2067 * 2068 * @param pk the primary key of the user 2069 * @param teamPKs the primary keys of the teams 2070 * @throws SystemException if a system exception occurred 2071 */ 2072 public void removeTeams(long pk, long[] teamPKs) 2073 throws com.liferay.portal.kernel.exception.SystemException; 2074 2075 /** 2076 * Removes the association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2077 * 2078 * @param pk the primary key of the user 2079 * @param teams the teams 2080 * @throws SystemException if a system exception occurred 2081 */ 2082 public void removeTeams(long pk, 2083 java.util.List<com.liferay.portal.model.Team> teams) 2084 throws com.liferay.portal.kernel.exception.SystemException; 2085 2086 /** 2087 * Sets the teams associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2088 * 2089 * @param pk the primary key of the user 2090 * @param teamPKs the primary keys of the teams to be associated with the user 2091 * @throws SystemException if a system exception occurred 2092 */ 2093 public void setTeams(long pk, long[] teamPKs) 2094 throws com.liferay.portal.kernel.exception.SystemException; 2095 2096 /** 2097 * Sets the teams associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2098 * 2099 * @param pk the primary key of the user 2100 * @param teams the teams to be associated with the user 2101 * @throws SystemException if a system exception occurred 2102 */ 2103 public void setTeams(long pk, 2104 java.util.List<com.liferay.portal.model.Team> teams) 2105 throws com.liferay.portal.kernel.exception.SystemException; 2106 2107 /** 2108 * Returns all the user groups associated with the user. 2109 * 2110 * @param pk the primary key of the user 2111 * @return the user groups associated with the user 2112 * @throws SystemException if a system exception occurred 2113 */ 2114 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 2115 long pk) throws com.liferay.portal.kernel.exception.SystemException; 2116 2117 /** 2118 * Returns a range of all the user groups associated with the user. 2119 * 2120 * <p> 2121 * 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. 2122 * </p> 2123 * 2124 * @param pk the primary key of the user 2125 * @param start the lower bound of the range of users 2126 * @param end the upper bound of the range of users (not inclusive) 2127 * @return the range of user groups associated with the user 2128 * @throws SystemException if a system exception occurred 2129 */ 2130 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 2131 long pk, int start, int end) 2132 throws com.liferay.portal.kernel.exception.SystemException; 2133 2134 /** 2135 * Returns an ordered range of all the user groups associated with the user. 2136 * 2137 * <p> 2138 * 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. 2139 * </p> 2140 * 2141 * @param pk the primary key of the user 2142 * @param start the lower bound of the range of users 2143 * @param end the upper bound of the range of users (not inclusive) 2144 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 2145 * @return the ordered range of user groups associated with the user 2146 * @throws SystemException if a system exception occurred 2147 */ 2148 public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups( 2149 long pk, int start, int end, 2150 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 2151 throws com.liferay.portal.kernel.exception.SystemException; 2152 2153 /** 2154 * Returns the number of user groups associated with the user. 2155 * 2156 * @param pk the primary key of the user 2157 * @return the number of user groups associated with the user 2158 * @throws SystemException if a system exception occurred 2159 */ 2160 public int getUserGroupsSize(long pk) 2161 throws com.liferay.portal.kernel.exception.SystemException; 2162 2163 /** 2164 * Returns <code>true</code> if the user group is associated with the user. 2165 * 2166 * @param pk the primary key of the user 2167 * @param userGroupPK the primary key of the user group 2168 * @return <code>true</code> if the user group is associated with the user; <code>false</code> otherwise 2169 * @throws SystemException if a system exception occurred 2170 */ 2171 public boolean containsUserGroup(long pk, long userGroupPK) 2172 throws com.liferay.portal.kernel.exception.SystemException; 2173 2174 /** 2175 * Returns <code>true</code> if the user has any user groups associated with it. 2176 * 2177 * @param pk the primary key of the user to check for associations with user groups 2178 * @return <code>true</code> if the user has any user groups associated with it; <code>false</code> otherwise 2179 * @throws SystemException if a system exception occurred 2180 */ 2181 public boolean containsUserGroups(long pk) 2182 throws com.liferay.portal.kernel.exception.SystemException; 2183 2184 /** 2185 * Adds an association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2186 * 2187 * @param pk the primary key of the user 2188 * @param userGroupPK the primary key of the user group 2189 * @throws SystemException if a system exception occurred 2190 */ 2191 public void addUserGroup(long pk, long userGroupPK) 2192 throws com.liferay.portal.kernel.exception.SystemException; 2193 2194 /** 2195 * Adds an association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2196 * 2197 * @param pk the primary key of the user 2198 * @param userGroup the user group 2199 * @throws SystemException if a system exception occurred 2200 */ 2201 public void addUserGroup(long pk, 2202 com.liferay.portal.model.UserGroup userGroup) 2203 throws com.liferay.portal.kernel.exception.SystemException; 2204 2205 /** 2206 * Adds an association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2207 * 2208 * @param pk the primary key of the user 2209 * @param userGroupPKs the primary keys of the user groups 2210 * @throws SystemException if a system exception occurred 2211 */ 2212 public void addUserGroups(long pk, long[] userGroupPKs) 2213 throws com.liferay.portal.kernel.exception.SystemException; 2214 2215 /** 2216 * Adds an association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2217 * 2218 * @param pk the primary key of the user 2219 * @param userGroups the user groups 2220 * @throws SystemException if a system exception occurred 2221 */ 2222 public void addUserGroups(long pk, 2223 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 2224 throws com.liferay.portal.kernel.exception.SystemException; 2225 2226 /** 2227 * Clears all associations between the user and its user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2228 * 2229 * @param pk the primary key of the user to clear the associated user groups from 2230 * @throws SystemException if a system exception occurred 2231 */ 2232 public void clearUserGroups(long pk) 2233 throws com.liferay.portal.kernel.exception.SystemException; 2234 2235 /** 2236 * Removes the association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2237 * 2238 * @param pk the primary key of the user 2239 * @param userGroupPK the primary key of the user group 2240 * @throws SystemException if a system exception occurred 2241 */ 2242 public void removeUserGroup(long pk, long userGroupPK) 2243 throws com.liferay.portal.kernel.exception.SystemException; 2244 2245 /** 2246 * Removes the association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2247 * 2248 * @param pk the primary key of the user 2249 * @param userGroup the user group 2250 * @throws SystemException if a system exception occurred 2251 */ 2252 public void removeUserGroup(long pk, 2253 com.liferay.portal.model.UserGroup userGroup) 2254 throws com.liferay.portal.kernel.exception.SystemException; 2255 2256 /** 2257 * Removes the association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2258 * 2259 * @param pk the primary key of the user 2260 * @param userGroupPKs the primary keys of the user groups 2261 * @throws SystemException if a system exception occurred 2262 */ 2263 public void removeUserGroups(long pk, long[] userGroupPKs) 2264 throws com.liferay.portal.kernel.exception.SystemException; 2265 2266 /** 2267 * Removes the association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2268 * 2269 * @param pk the primary key of the user 2270 * @param userGroups the user groups 2271 * @throws SystemException if a system exception occurred 2272 */ 2273 public void removeUserGroups(long pk, 2274 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 2275 throws com.liferay.portal.kernel.exception.SystemException; 2276 2277 /** 2278 * Sets the user groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2279 * 2280 * @param pk the primary key of the user 2281 * @param userGroupPKs the primary keys of the user groups to be associated with the user 2282 * @throws SystemException if a system exception occurred 2283 */ 2284 public void setUserGroups(long pk, long[] userGroupPKs) 2285 throws com.liferay.portal.kernel.exception.SystemException; 2286 2287 /** 2288 * Sets the user groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache. 2289 * 2290 * @param pk the primary key of the user 2291 * @param userGroups the user groups to be associated with the user 2292 * @throws SystemException if a system exception occurred 2293 */ 2294 public void setUserGroups(long pk, 2295 java.util.List<com.liferay.portal.model.UserGroup> userGroups) 2296 throws com.liferay.portal.kernel.exception.SystemException; 2297 }