001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portlet.ratings.service.persistence; 016 017 import com.liferay.portal.kernel.exception.SystemException; 018 import com.liferay.portal.service.persistence.BasePersistence; 019 020 import com.liferay.portlet.ratings.model.RatingsEntry; 021 022 /** 023 * The persistence interface for the ratings entry service. 024 * 025 * <p> 026 * Caching information and settings can be found in <code>portal.properties</code> 027 * </p> 028 * 029 * @author Brian Wing Shun Chan 030 * @see RatingsEntryPersistenceImpl 031 * @see RatingsEntryUtil 032 * @generated 033 */ 034 public interface RatingsEntryPersistence extends BasePersistence<RatingsEntry> { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify or reference this interface directly. Always use {@link RatingsEntryUtil} to access the ratings entry persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 039 */ 040 041 /** 042 * Caches the ratings entry in the entity cache if it is enabled. 043 * 044 * @param ratingsEntry the ratings entry to cache 045 */ 046 public void cacheResult( 047 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry); 048 049 /** 050 * Caches the ratings entries in the entity cache if it is enabled. 051 * 052 * @param ratingsEntries the ratings entries to cache 053 */ 054 public void cacheResult( 055 java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> ratingsEntries); 056 057 /** 058 * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database. 059 * 060 * @param entryId the primary key for the new ratings entry 061 * @return the new ratings entry 062 */ 063 public com.liferay.portlet.ratings.model.RatingsEntry create(long entryId); 064 065 /** 066 * Removes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param entryId the primary key of the ratings entry to remove 069 * @return the ratings entry that was removed 070 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a ratings entry with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public com.liferay.portlet.ratings.model.RatingsEntry remove(long entryId) 074 throws com.liferay.portal.kernel.exception.SystemException, 075 com.liferay.portlet.ratings.NoSuchEntryException; 076 077 public com.liferay.portlet.ratings.model.RatingsEntry updateImpl( 078 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry, 079 boolean merge) 080 throws com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Finds the ratings entry with the primary key or throws a {@link com.liferay.portlet.ratings.NoSuchEntryException} if it could not be found. 084 * 085 * @param entryId the primary key of the ratings entry to find 086 * @return the ratings entry 087 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a ratings entry with the primary key could not be found 088 * @throws SystemException if a system exception occurred 089 */ 090 public com.liferay.portlet.ratings.model.RatingsEntry findByPrimaryKey( 091 long entryId) 092 throws com.liferay.portal.kernel.exception.SystemException, 093 com.liferay.portlet.ratings.NoSuchEntryException; 094 095 /** 096 * Finds the ratings entry with the primary key or returns <code>null</code> if it could not be found. 097 * 098 * @param entryId the primary key of the ratings entry to find 099 * @return the ratings entry, or <code>null</code> if a ratings entry with the primary key could not be found 100 * @throws SystemException if a system exception occurred 101 */ 102 public com.liferay.portlet.ratings.model.RatingsEntry fetchByPrimaryKey( 103 long entryId) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Finds all the ratings entries where classNameId = ? and classPK = ?. 108 * 109 * @param classNameId the class name ID to search with 110 * @param classPK the class p k to search with 111 * @return the matching ratings entries 112 * @throws SystemException if a system exception occurred 113 */ 114 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C( 115 long classNameId, long classPK) 116 throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Finds a range of all the ratings entries where classNameId = ? and classPK = ?. 120 * 121 * <p> 122 * 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. 123 * </p> 124 * 125 * @param classNameId the class name ID to search with 126 * @param classPK the class p k to search with 127 * @param start the lower bound of the range of ratings entries to return 128 * @param end the upper bound of the range of ratings entries to return (not inclusive) 129 * @return the range of matching ratings entries 130 * @throws SystemException if a system exception occurred 131 */ 132 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C( 133 long classNameId, long classPK, int start, int end) 134 throws com.liferay.portal.kernel.exception.SystemException; 135 136 /** 137 * Finds an ordered range of all the ratings entries where classNameId = ? and classPK = ?. 138 * 139 * <p> 140 * 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. 141 * </p> 142 * 143 * @param classNameId the class name ID to search with 144 * @param classPK the class p k to search with 145 * @param start the lower bound of the range of ratings entries to return 146 * @param end the upper bound of the range of ratings entries to return (not inclusive) 147 * @param orderByComparator the comparator to order the results by 148 * @return the ordered range of matching ratings entries 149 * @throws SystemException if a system exception occurred 150 */ 151 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C( 152 long classNameId, long classPK, int start, int end, 153 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 /** 157 * Finds the first ratings entry in the ordered set where classNameId = ? and classPK = ?. 158 * 159 * <p> 160 * 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. 161 * </p> 162 * 163 * @param classNameId the class name ID to search with 164 * @param classPK the class p k to search with 165 * @param orderByComparator the comparator to order the set by 166 * @return the first matching ratings entry 167 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a matching ratings entry could not be found 168 * @throws SystemException if a system exception occurred 169 */ 170 public com.liferay.portlet.ratings.model.RatingsEntry findByC_C_First( 171 long classNameId, long classPK, 172 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 173 throws com.liferay.portal.kernel.exception.SystemException, 174 com.liferay.portlet.ratings.NoSuchEntryException; 175 176 /** 177 * Finds the last ratings entry in the ordered set where classNameId = ? and classPK = ?. 178 * 179 * <p> 180 * 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. 181 * </p> 182 * 183 * @param classNameId the class name ID to search with 184 * @param classPK the class p k to search with 185 * @param orderByComparator the comparator to order the set by 186 * @return the last matching ratings entry 187 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a matching ratings entry could not be found 188 * @throws SystemException if a system exception occurred 189 */ 190 public com.liferay.portlet.ratings.model.RatingsEntry findByC_C_Last( 191 long classNameId, long classPK, 192 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 193 throws com.liferay.portal.kernel.exception.SystemException, 194 com.liferay.portlet.ratings.NoSuchEntryException; 195 196 /** 197 * Finds the ratings entries before and after the current ratings entry in the ordered set where classNameId = ? and classPK = ?. 198 * 199 * <p> 200 * 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. 201 * </p> 202 * 203 * @param entryId the primary key of the current ratings entry 204 * @param classNameId the class name ID to search with 205 * @param classPK the class p k to search with 206 * @param orderByComparator the comparator to order the set by 207 * @return the previous, current, and next ratings entry 208 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a ratings entry with the primary key could not be found 209 * @throws SystemException if a system exception occurred 210 */ 211 public com.liferay.portlet.ratings.model.RatingsEntry[] findByC_C_PrevAndNext( 212 long entryId, long classNameId, long classPK, 213 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 214 throws com.liferay.portal.kernel.exception.SystemException, 215 com.liferay.portlet.ratings.NoSuchEntryException; 216 217 /** 218 * Finds the ratings entry where userId = ? and classNameId = ? and classPK = ? or throws a {@link com.liferay.portlet.ratings.NoSuchEntryException} if it could not be found. 219 * 220 * @param userId the user ID to search with 221 * @param classNameId the class name ID to search with 222 * @param classPK the class p k to search with 223 * @return the matching ratings entry 224 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a matching ratings entry could not be found 225 * @throws SystemException if a system exception occurred 226 */ 227 public com.liferay.portlet.ratings.model.RatingsEntry findByU_C_C( 228 long userId, long classNameId, long classPK) 229 throws com.liferay.portal.kernel.exception.SystemException, 230 com.liferay.portlet.ratings.NoSuchEntryException; 231 232 /** 233 * Finds the ratings entry where userId = ? and classNameId = ? and classPK = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 234 * 235 * @param userId the user ID to search with 236 * @param classNameId the class name ID to search with 237 * @param classPK the class p k to search with 238 * @return the matching ratings entry, or <code>null</code> if a matching ratings entry could not be found 239 * @throws SystemException if a system exception occurred 240 */ 241 public com.liferay.portlet.ratings.model.RatingsEntry fetchByU_C_C( 242 long userId, long classNameId, long classPK) 243 throws com.liferay.portal.kernel.exception.SystemException; 244 245 /** 246 * Finds the ratings entry where userId = ? and classNameId = ? and classPK = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 247 * 248 * @param userId the user ID to search with 249 * @param classNameId the class name ID to search with 250 * @param classPK the class p k to search with 251 * @return the matching ratings entry, or <code>null</code> if a matching ratings entry could not be found 252 * @throws SystemException if a system exception occurred 253 */ 254 public com.liferay.portlet.ratings.model.RatingsEntry fetchByU_C_C( 255 long userId, long classNameId, long classPK, boolean retrieveFromCache) 256 throws com.liferay.portal.kernel.exception.SystemException; 257 258 /** 259 * Finds all the ratings entries where classNameId = ? and classPK = ? and score = ?. 260 * 261 * @param classNameId the class name ID to search with 262 * @param classPK the class p k to search with 263 * @param score the score to search with 264 * @return the matching ratings entries 265 * @throws SystemException if a system exception occurred 266 */ 267 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C_S( 268 long classNameId, long classPK, double score) 269 throws com.liferay.portal.kernel.exception.SystemException; 270 271 /** 272 * Finds a range of all the ratings entries where classNameId = ? and classPK = ? and score = ?. 273 * 274 * <p> 275 * 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. 276 * </p> 277 * 278 * @param classNameId the class name ID to search with 279 * @param classPK the class p k to search with 280 * @param score the score to search with 281 * @param start the lower bound of the range of ratings entries to return 282 * @param end the upper bound of the range of ratings entries to return (not inclusive) 283 * @return the range of matching ratings entries 284 * @throws SystemException if a system exception occurred 285 */ 286 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C_S( 287 long classNameId, long classPK, double score, int start, int end) 288 throws com.liferay.portal.kernel.exception.SystemException; 289 290 /** 291 * Finds an ordered range of all the ratings entries where classNameId = ? and classPK = ? and score = ?. 292 * 293 * <p> 294 * 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. 295 * </p> 296 * 297 * @param classNameId the class name ID to search with 298 * @param classPK the class p k to search with 299 * @param score the score to search with 300 * @param start the lower bound of the range of ratings entries to return 301 * @param end the upper bound of the range of ratings entries to return (not inclusive) 302 * @param orderByComparator the comparator to order the results by 303 * @return the ordered range of matching ratings entries 304 * @throws SystemException if a system exception occurred 305 */ 306 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findByC_C_S( 307 long classNameId, long classPK, double score, int start, int end, 308 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 309 throws com.liferay.portal.kernel.exception.SystemException; 310 311 /** 312 * Finds the first ratings entry in the ordered set where classNameId = ? and classPK = ? and score = ?. 313 * 314 * <p> 315 * 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. 316 * </p> 317 * 318 * @param classNameId the class name ID to search with 319 * @param classPK the class p k to search with 320 * @param score the score to search with 321 * @param orderByComparator the comparator to order the set by 322 * @return the first matching ratings entry 323 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a matching ratings entry could not be found 324 * @throws SystemException if a system exception occurred 325 */ 326 public com.liferay.portlet.ratings.model.RatingsEntry findByC_C_S_First( 327 long classNameId, long classPK, double score, 328 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 329 throws com.liferay.portal.kernel.exception.SystemException, 330 com.liferay.portlet.ratings.NoSuchEntryException; 331 332 /** 333 * Finds the last ratings entry in the ordered set where classNameId = ? and classPK = ? and score = ?. 334 * 335 * <p> 336 * 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. 337 * </p> 338 * 339 * @param classNameId the class name ID to search with 340 * @param classPK the class p k to search with 341 * @param score the score to search with 342 * @param orderByComparator the comparator to order the set by 343 * @return the last matching ratings entry 344 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a matching ratings entry could not be found 345 * @throws SystemException if a system exception occurred 346 */ 347 public com.liferay.portlet.ratings.model.RatingsEntry findByC_C_S_Last( 348 long classNameId, long classPK, double score, 349 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 350 throws com.liferay.portal.kernel.exception.SystemException, 351 com.liferay.portlet.ratings.NoSuchEntryException; 352 353 /** 354 * Finds the ratings entries before and after the current ratings entry in the ordered set where classNameId = ? and classPK = ? and score = ?. 355 * 356 * <p> 357 * 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. 358 * </p> 359 * 360 * @param entryId the primary key of the current ratings entry 361 * @param classNameId the class name ID to search with 362 * @param classPK the class p k to search with 363 * @param score the score to search with 364 * @param orderByComparator the comparator to order the set by 365 * @return the previous, current, and next ratings entry 366 * @throws com.liferay.portlet.ratings.NoSuchEntryException if a ratings entry with the primary key could not be found 367 * @throws SystemException if a system exception occurred 368 */ 369 public com.liferay.portlet.ratings.model.RatingsEntry[] findByC_C_S_PrevAndNext( 370 long entryId, long classNameId, long classPK, double score, 371 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 372 throws com.liferay.portal.kernel.exception.SystemException, 373 com.liferay.portlet.ratings.NoSuchEntryException; 374 375 /** 376 * Finds all the ratings entries. 377 * 378 * @return the ratings entries 379 * @throws SystemException if a system exception occurred 380 */ 381 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findAll() 382 throws com.liferay.portal.kernel.exception.SystemException; 383 384 /** 385 * Finds a range of all the ratings entries. 386 * 387 * <p> 388 * 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. 389 * </p> 390 * 391 * @param start the lower bound of the range of ratings entries to return 392 * @param end the upper bound of the range of ratings entries to return (not inclusive) 393 * @return the range of ratings entries 394 * @throws SystemException if a system exception occurred 395 */ 396 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findAll( 397 int start, int end) 398 throws com.liferay.portal.kernel.exception.SystemException; 399 400 /** 401 * Finds an ordered range of all the ratings entries. 402 * 403 * <p> 404 * 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. 405 * </p> 406 * 407 * @param start the lower bound of the range of ratings entries to return 408 * @param end the upper bound of the range of ratings entries to return (not inclusive) 409 * @param orderByComparator the comparator to order the results by 410 * @return the ordered range of ratings entries 411 * @throws SystemException if a system exception occurred 412 */ 413 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> findAll( 414 int start, int end, 415 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 416 throws com.liferay.portal.kernel.exception.SystemException; 417 418 /** 419 * Removes all the ratings entries where classNameId = ? and classPK = ? from the database. 420 * 421 * @param classNameId the class name ID to search with 422 * @param classPK the class p k to search with 423 * @throws SystemException if a system exception occurred 424 */ 425 public void removeByC_C(long classNameId, long classPK) 426 throws com.liferay.portal.kernel.exception.SystemException; 427 428 /** 429 * Removes the ratings entry where userId = ? and classNameId = ? and classPK = ? from the database. 430 * 431 * @param userId the user ID to search with 432 * @param classNameId the class name ID to search with 433 * @param classPK the class p k to search with 434 * @throws SystemException if a system exception occurred 435 */ 436 public void removeByU_C_C(long userId, long classNameId, long classPK) 437 throws com.liferay.portal.kernel.exception.SystemException, 438 com.liferay.portlet.ratings.NoSuchEntryException; 439 440 /** 441 * Removes all the ratings entries where classNameId = ? and classPK = ? and score = ? from the database. 442 * 443 * @param classNameId the class name ID to search with 444 * @param classPK the class p k to search with 445 * @param score the score to search with 446 * @throws SystemException if a system exception occurred 447 */ 448 public void removeByC_C_S(long classNameId, long classPK, double score) 449 throws com.liferay.portal.kernel.exception.SystemException; 450 451 /** 452 * Removes all the ratings entries from the database. 453 * 454 * @throws SystemException if a system exception occurred 455 */ 456 public void removeAll() 457 throws com.liferay.portal.kernel.exception.SystemException; 458 459 /** 460 * Counts all the ratings entries where classNameId = ? and classPK = ?. 461 * 462 * @param classNameId the class name ID to search with 463 * @param classPK the class p k to search with 464 * @return the number of matching ratings entries 465 * @throws SystemException if a system exception occurred 466 */ 467 public int countByC_C(long classNameId, long classPK) 468 throws com.liferay.portal.kernel.exception.SystemException; 469 470 /** 471 * Counts all the ratings entries where userId = ? and classNameId = ? and classPK = ?. 472 * 473 * @param userId the user ID to search with 474 * @param classNameId the class name ID to search with 475 * @param classPK the class p k to search with 476 * @return the number of matching ratings entries 477 * @throws SystemException if a system exception occurred 478 */ 479 public int countByU_C_C(long userId, long classNameId, long classPK) 480 throws com.liferay.portal.kernel.exception.SystemException; 481 482 /** 483 * Counts all the ratings entries where classNameId = ? and classPK = ? and score = ?. 484 * 485 * @param classNameId the class name ID to search with 486 * @param classPK the class p k to search with 487 * @param score the score to search with 488 * @return the number of matching ratings entries 489 * @throws SystemException if a system exception occurred 490 */ 491 public int countByC_C_S(long classNameId, long classPK, double score) 492 throws com.liferay.portal.kernel.exception.SystemException; 493 494 /** 495 * Counts all the ratings entries. 496 * 497 * @return the number of ratings entries 498 * @throws SystemException if a system exception occurred 499 */ 500 public int countAll() 501 throws com.liferay.portal.kernel.exception.SystemException; 502 503 public RatingsEntry remove(RatingsEntry ratingsEntry) 504 throws SystemException; 505 }