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