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.portlet.announcements.service.persistence; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.dao.orm.DynamicQuery; 019 import com.liferay.portal.kernel.exception.SystemException; 020 import com.liferay.portal.kernel.util.OrderByComparator; 021 import com.liferay.portal.kernel.util.ReferenceRegistry; 022 import com.liferay.portal.service.ServiceContext; 023 024 import com.liferay.portlet.announcements.model.AnnouncementsFlag; 025 026 import java.util.List; 027 028 /** 029 * The persistence utility for the announcements flag service. This utility wraps {@link AnnouncementsFlagPersistenceImpl} and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class. 030 * 031 * <p> 032 * Caching information and settings can be found in <code>portal.properties</code> 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see AnnouncementsFlagPersistence 037 * @see AnnouncementsFlagPersistenceImpl 038 * @generated 039 */ 040 public class AnnouncementsFlagUtil { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify this class directly. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this class. 045 */ 046 047 /** 048 * @see com.liferay.portal.service.persistence.BasePersistence#clearCache() 049 */ 050 public static void clearCache() { 051 getPersistence().clearCache(); 052 } 053 054 /** 055 * @see com.liferay.portal.service.persistence.BasePersistence#clearCache(com.liferay.portal.model.BaseModel) 056 */ 057 public static void clearCache(AnnouncementsFlag announcementsFlag) { 058 getPersistence().clearCache(announcementsFlag); 059 } 060 061 /** 062 * @see com.liferay.portal.service.persistence.BasePersistence#countWithDynamicQuery(DynamicQuery) 063 */ 064 public long countWithDynamicQuery(DynamicQuery dynamicQuery) 065 throws SystemException { 066 return getPersistence().countWithDynamicQuery(dynamicQuery); 067 } 068 069 /** 070 * @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery) 071 */ 072 public static List<AnnouncementsFlag> findWithDynamicQuery( 073 DynamicQuery dynamicQuery) throws SystemException { 074 return getPersistence().findWithDynamicQuery(dynamicQuery); 075 } 076 077 /** 078 * @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int) 079 */ 080 public static List<AnnouncementsFlag> findWithDynamicQuery( 081 DynamicQuery dynamicQuery, int start, int end) 082 throws SystemException { 083 return getPersistence().findWithDynamicQuery(dynamicQuery, start, end); 084 } 085 086 /** 087 * @see com.liferay.portal.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator) 088 */ 089 public static List<AnnouncementsFlag> findWithDynamicQuery( 090 DynamicQuery dynamicQuery, int start, int end, 091 OrderByComparator orderByComparator) throws SystemException { 092 return getPersistence() 093 .findWithDynamicQuery(dynamicQuery, start, end, 094 orderByComparator); 095 } 096 097 /** 098 * @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel) 099 */ 100 public static AnnouncementsFlag update(AnnouncementsFlag announcementsFlag) 101 throws SystemException { 102 return getPersistence().update(announcementsFlag); 103 } 104 105 /** 106 * @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel, ServiceContext) 107 */ 108 public static AnnouncementsFlag update( 109 AnnouncementsFlag announcementsFlag, ServiceContext serviceContext) 110 throws SystemException { 111 return getPersistence().update(announcementsFlag, serviceContext); 112 } 113 114 /** 115 * Returns all the announcements flags where entryId = ?. 116 * 117 * @param entryId the entry ID 118 * @return the matching announcements flags 119 * @throws SystemException if a system exception occurred 120 */ 121 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findByEntryId( 122 long entryId) 123 throws com.liferay.portal.kernel.exception.SystemException { 124 return getPersistence().findByEntryId(entryId); 125 } 126 127 /** 128 * Returns a range of all the announcements flags where entryId = ?. 129 * 130 * <p> 131 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 132 * </p> 133 * 134 * @param entryId the entry ID 135 * @param start the lower bound of the range of announcements flags 136 * @param end the upper bound of the range of announcements flags (not inclusive) 137 * @return the range of matching announcements flags 138 * @throws SystemException if a system exception occurred 139 */ 140 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findByEntryId( 141 long entryId, int start, int end) 142 throws com.liferay.portal.kernel.exception.SystemException { 143 return getPersistence().findByEntryId(entryId, start, end); 144 } 145 146 /** 147 * Returns an ordered range of all the announcements flags where entryId = ?. 148 * 149 * <p> 150 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 151 * </p> 152 * 153 * @param entryId the entry ID 154 * @param start the lower bound of the range of announcements flags 155 * @param end the upper bound of the range of announcements flags (not inclusive) 156 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 157 * @return the ordered range of matching announcements flags 158 * @throws SystemException if a system exception occurred 159 */ 160 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findByEntryId( 161 long entryId, int start, int end, 162 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getPersistence() 165 .findByEntryId(entryId, start, end, orderByComparator); 166 } 167 168 /** 169 * Returns the first announcements flag in the ordered set where entryId = ?. 170 * 171 * @param entryId the entry ID 172 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 173 * @return the first matching announcements flag 174 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a matching announcements flag could not be found 175 * @throws SystemException if a system exception occurred 176 */ 177 public static com.liferay.portlet.announcements.model.AnnouncementsFlag findByEntryId_First( 178 long entryId, 179 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 180 throws com.liferay.portal.kernel.exception.SystemException, 181 com.liferay.portlet.announcements.NoSuchFlagException { 182 return getPersistence().findByEntryId_First(entryId, orderByComparator); 183 } 184 185 /** 186 * Returns the first announcements flag in the ordered set where entryId = ?. 187 * 188 * @param entryId the entry ID 189 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 190 * @return the first matching announcements flag, or <code>null</code> if a matching announcements flag could not be found 191 * @throws SystemException if a system exception occurred 192 */ 193 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchByEntryId_First( 194 long entryId, 195 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 196 throws com.liferay.portal.kernel.exception.SystemException { 197 return getPersistence().fetchByEntryId_First(entryId, orderByComparator); 198 } 199 200 /** 201 * Returns the last announcements flag in the ordered set where entryId = ?. 202 * 203 * @param entryId the entry ID 204 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 205 * @return the last matching announcements flag 206 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a matching announcements flag could not be found 207 * @throws SystemException if a system exception occurred 208 */ 209 public static com.liferay.portlet.announcements.model.AnnouncementsFlag findByEntryId_Last( 210 long entryId, 211 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 212 throws com.liferay.portal.kernel.exception.SystemException, 213 com.liferay.portlet.announcements.NoSuchFlagException { 214 return getPersistence().findByEntryId_Last(entryId, orderByComparator); 215 } 216 217 /** 218 * Returns the last announcements flag in the ordered set where entryId = ?. 219 * 220 * @param entryId the entry ID 221 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 222 * @return the last matching announcements flag, or <code>null</code> if a matching announcements flag could not be found 223 * @throws SystemException if a system exception occurred 224 */ 225 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchByEntryId_Last( 226 long entryId, 227 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 228 throws com.liferay.portal.kernel.exception.SystemException { 229 return getPersistence().fetchByEntryId_Last(entryId, orderByComparator); 230 } 231 232 /** 233 * Returns the announcements flags before and after the current announcements flag in the ordered set where entryId = ?. 234 * 235 * @param flagId the primary key of the current announcements flag 236 * @param entryId the entry ID 237 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 238 * @return the previous, current, and next announcements flag 239 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a announcements flag with the primary key could not be found 240 * @throws SystemException if a system exception occurred 241 */ 242 public static com.liferay.portlet.announcements.model.AnnouncementsFlag[] findByEntryId_PrevAndNext( 243 long flagId, long entryId, 244 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 245 throws com.liferay.portal.kernel.exception.SystemException, 246 com.liferay.portlet.announcements.NoSuchFlagException { 247 return getPersistence() 248 .findByEntryId_PrevAndNext(flagId, entryId, orderByComparator); 249 } 250 251 /** 252 * Removes all the announcements flags where entryId = ? from the database. 253 * 254 * @param entryId the entry ID 255 * @throws SystemException if a system exception occurred 256 */ 257 public static void removeByEntryId(long entryId) 258 throws com.liferay.portal.kernel.exception.SystemException { 259 getPersistence().removeByEntryId(entryId); 260 } 261 262 /** 263 * Returns the number of announcements flags where entryId = ?. 264 * 265 * @param entryId the entry ID 266 * @return the number of matching announcements flags 267 * @throws SystemException if a system exception occurred 268 */ 269 public static int countByEntryId(long entryId) 270 throws com.liferay.portal.kernel.exception.SystemException { 271 return getPersistence().countByEntryId(entryId); 272 } 273 274 /** 275 * Returns the announcements flag where userId = ? and entryId = ? and value = ? or throws a {@link com.liferay.portlet.announcements.NoSuchFlagException} if it could not be found. 276 * 277 * @param userId the user ID 278 * @param entryId the entry ID 279 * @param value the value 280 * @return the matching announcements flag 281 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a matching announcements flag could not be found 282 * @throws SystemException if a system exception occurred 283 */ 284 public static com.liferay.portlet.announcements.model.AnnouncementsFlag findByU_E_V( 285 long userId, long entryId, int value) 286 throws com.liferay.portal.kernel.exception.SystemException, 287 com.liferay.portlet.announcements.NoSuchFlagException { 288 return getPersistence().findByU_E_V(userId, entryId, value); 289 } 290 291 /** 292 * Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 293 * 294 * @param userId the user ID 295 * @param entryId the entry ID 296 * @param value the value 297 * @return the matching announcements flag, or <code>null</code> if a matching announcements flag could not be found 298 * @throws SystemException if a system exception occurred 299 */ 300 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchByU_E_V( 301 long userId, long entryId, int value) 302 throws com.liferay.portal.kernel.exception.SystemException { 303 return getPersistence().fetchByU_E_V(userId, entryId, value); 304 } 305 306 /** 307 * Returns the announcements flag where userId = ? and entryId = ? and value = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 308 * 309 * @param userId the user ID 310 * @param entryId the entry ID 311 * @param value the value 312 * @param retrieveFromCache whether to use the finder cache 313 * @return the matching announcements flag, or <code>null</code> if a matching announcements flag could not be found 314 * @throws SystemException if a system exception occurred 315 */ 316 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchByU_E_V( 317 long userId, long entryId, int value, boolean retrieveFromCache) 318 throws com.liferay.portal.kernel.exception.SystemException { 319 return getPersistence() 320 .fetchByU_E_V(userId, entryId, value, retrieveFromCache); 321 } 322 323 /** 324 * Removes the announcements flag where userId = ? and entryId = ? and value = ? from the database. 325 * 326 * @param userId the user ID 327 * @param entryId the entry ID 328 * @param value the value 329 * @return the announcements flag that was removed 330 * @throws SystemException if a system exception occurred 331 */ 332 public static com.liferay.portlet.announcements.model.AnnouncementsFlag removeByU_E_V( 333 long userId, long entryId, int value) 334 throws com.liferay.portal.kernel.exception.SystemException, 335 com.liferay.portlet.announcements.NoSuchFlagException { 336 return getPersistence().removeByU_E_V(userId, entryId, value); 337 } 338 339 /** 340 * Returns the number of announcements flags where userId = ? and entryId = ? and value = ?. 341 * 342 * @param userId the user ID 343 * @param entryId the entry ID 344 * @param value the value 345 * @return the number of matching announcements flags 346 * @throws SystemException if a system exception occurred 347 */ 348 public static int countByU_E_V(long userId, long entryId, int value) 349 throws com.liferay.portal.kernel.exception.SystemException { 350 return getPersistence().countByU_E_V(userId, entryId, value); 351 } 352 353 /** 354 * Caches the announcements flag in the entity cache if it is enabled. 355 * 356 * @param announcementsFlag the announcements flag 357 */ 358 public static void cacheResult( 359 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) { 360 getPersistence().cacheResult(announcementsFlag); 361 } 362 363 /** 364 * Caches the announcements flags in the entity cache if it is enabled. 365 * 366 * @param announcementsFlags the announcements flags 367 */ 368 public static void cacheResult( 369 java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> announcementsFlags) { 370 getPersistence().cacheResult(announcementsFlags); 371 } 372 373 /** 374 * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database. 375 * 376 * @param flagId the primary key for the new announcements flag 377 * @return the new announcements flag 378 */ 379 public static com.liferay.portlet.announcements.model.AnnouncementsFlag create( 380 long flagId) { 381 return getPersistence().create(flagId); 382 } 383 384 /** 385 * Removes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners. 386 * 387 * @param flagId the primary key of the announcements flag 388 * @return the announcements flag that was removed 389 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a announcements flag with the primary key could not be found 390 * @throws SystemException if a system exception occurred 391 */ 392 public static com.liferay.portlet.announcements.model.AnnouncementsFlag remove( 393 long flagId) 394 throws com.liferay.portal.kernel.exception.SystemException, 395 com.liferay.portlet.announcements.NoSuchFlagException { 396 return getPersistence().remove(flagId); 397 } 398 399 public static com.liferay.portlet.announcements.model.AnnouncementsFlag updateImpl( 400 com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag) 401 throws com.liferay.portal.kernel.exception.SystemException { 402 return getPersistence().updateImpl(announcementsFlag); 403 } 404 405 /** 406 * Returns the announcements flag with the primary key or throws a {@link com.liferay.portlet.announcements.NoSuchFlagException} if it could not be found. 407 * 408 * @param flagId the primary key of the announcements flag 409 * @return the announcements flag 410 * @throws com.liferay.portlet.announcements.NoSuchFlagException if a announcements flag with the primary key could not be found 411 * @throws SystemException if a system exception occurred 412 */ 413 public static com.liferay.portlet.announcements.model.AnnouncementsFlag findByPrimaryKey( 414 long flagId) 415 throws com.liferay.portal.kernel.exception.SystemException, 416 com.liferay.portlet.announcements.NoSuchFlagException { 417 return getPersistence().findByPrimaryKey(flagId); 418 } 419 420 /** 421 * Returns the announcements flag with the primary key or returns <code>null</code> if it could not be found. 422 * 423 * @param flagId the primary key of the announcements flag 424 * @return the announcements flag, or <code>null</code> if a announcements flag with the primary key could not be found 425 * @throws SystemException if a system exception occurred 426 */ 427 public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchByPrimaryKey( 428 long flagId) throws com.liferay.portal.kernel.exception.SystemException { 429 return getPersistence().fetchByPrimaryKey(flagId); 430 } 431 432 /** 433 * Returns all the announcements flags. 434 * 435 * @return the announcements flags 436 * @throws SystemException if a system exception occurred 437 */ 438 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findAll() 439 throws com.liferay.portal.kernel.exception.SystemException { 440 return getPersistence().findAll(); 441 } 442 443 /** 444 * Returns a range of all the announcements flags. 445 * 446 * <p> 447 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 448 * </p> 449 * 450 * @param start the lower bound of the range of announcements flags 451 * @param end the upper bound of the range of announcements flags (not inclusive) 452 * @return the range of announcements flags 453 * @throws SystemException if a system exception occurred 454 */ 455 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findAll( 456 int start, int end) 457 throws com.liferay.portal.kernel.exception.SystemException { 458 return getPersistence().findAll(start, end); 459 } 460 461 /** 462 * Returns an ordered range of all the announcements flags. 463 * 464 * <p> 465 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 466 * </p> 467 * 468 * @param start the lower bound of the range of announcements flags 469 * @param end the upper bound of the range of announcements flags (not inclusive) 470 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 471 * @return the ordered range of announcements flags 472 * @throws SystemException if a system exception occurred 473 */ 474 public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> findAll( 475 int start, int end, 476 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 477 throws com.liferay.portal.kernel.exception.SystemException { 478 return getPersistence().findAll(start, end, orderByComparator); 479 } 480 481 /** 482 * Removes all the announcements flags from the database. 483 * 484 * @throws SystemException if a system exception occurred 485 */ 486 public static void removeAll() 487 throws com.liferay.portal.kernel.exception.SystemException { 488 getPersistence().removeAll(); 489 } 490 491 /** 492 * Returns the number of announcements flags. 493 * 494 * @return the number of announcements flags 495 * @throws SystemException if a system exception occurred 496 */ 497 public static int countAll() 498 throws com.liferay.portal.kernel.exception.SystemException { 499 return getPersistence().countAll(); 500 } 501 502 public static AnnouncementsFlagPersistence getPersistence() { 503 if (_persistence == null) { 504 _persistence = (AnnouncementsFlagPersistence)PortalBeanLocatorUtil.locate(AnnouncementsFlagPersistence.class.getName()); 505 506 ReferenceRegistry.registerReference(AnnouncementsFlagUtil.class, 507 "_persistence"); 508 } 509 510 return _persistence; 511 } 512 513 /** 514 * @deprecated 515 */ 516 public void setPersistence(AnnouncementsFlagPersistence persistence) { 517 } 518 519 private static AnnouncementsFlagPersistence _persistence; 520 }