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