001 /** 002 * Copyright (c) 2000-2011 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.ClassName; 023 import com.liferay.portal.service.ServiceContext; 024 025 import java.util.List; 026 027 /** 028 * The persistence utility for the class name service. This utility wraps {@link ClassNamePersistenceImpl} 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 ClassNamePersistence 036 * @see ClassNamePersistenceImpl 037 * @generated 038 */ 039 public class ClassNameUtil { 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(ClassName className) { 057 getPersistence().clearCache(className); 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<ClassName> 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<ClassName> 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<ClassName> 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#remove(com.liferay.portal.model.BaseModel) 098 */ 099 public static ClassName remove(ClassName className) 100 throws SystemException { 101 return getPersistence().remove(className); 102 } 103 104 /** 105 * @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel, boolean) 106 */ 107 public static ClassName update(ClassName className, boolean merge) 108 throws SystemException { 109 return getPersistence().update(className, merge); 110 } 111 112 /** 113 * @see com.liferay.portal.service.persistence.BasePersistence#update(com.liferay.portal.model.BaseModel, boolean, ServiceContext) 114 */ 115 public static ClassName update(ClassName className, boolean merge, 116 ServiceContext serviceContext) throws SystemException { 117 return getPersistence().update(className, merge, serviceContext); 118 } 119 120 /** 121 * Caches the class name in the entity cache if it is enabled. 122 * 123 * @param className the class name 124 */ 125 public static void cacheResult(com.liferay.portal.model.ClassName className) { 126 getPersistence().cacheResult(className); 127 } 128 129 /** 130 * Caches the class names in the entity cache if it is enabled. 131 * 132 * @param classNames the class names 133 */ 134 public static void cacheResult( 135 java.util.List<com.liferay.portal.model.ClassName> classNames) { 136 getPersistence().cacheResult(classNames); 137 } 138 139 /** 140 * Creates a new class name with the primary key. Does not add the class name to the database. 141 * 142 * @param classNameId the primary key for the new class name 143 * @return the new class name 144 */ 145 public static com.liferay.portal.model.ClassName create(long classNameId) { 146 return getPersistence().create(classNameId); 147 } 148 149 /** 150 * Removes the class name with the primary key from the database. Also notifies the appropriate model listeners. 151 * 152 * @param classNameId the primary key of the class name 153 * @return the class name that was removed 154 * @throws com.liferay.portal.NoSuchClassNameException if a class name with the primary key could not be found 155 * @throws SystemException if a system exception occurred 156 */ 157 public static com.liferay.portal.model.ClassName remove(long classNameId) 158 throws com.liferay.portal.NoSuchClassNameException, 159 com.liferay.portal.kernel.exception.SystemException { 160 return getPersistence().remove(classNameId); 161 } 162 163 public static com.liferay.portal.model.ClassName updateImpl( 164 com.liferay.portal.model.ClassName className, boolean merge) 165 throws com.liferay.portal.kernel.exception.SystemException { 166 return getPersistence().updateImpl(className, merge); 167 } 168 169 /** 170 * Returns the class name with the primary key or throws a {@link com.liferay.portal.NoSuchClassNameException} if it could not be found. 171 * 172 * @param classNameId the primary key of the class name 173 * @return the class name 174 * @throws com.liferay.portal.NoSuchClassNameException if a class name with the primary key could not be found 175 * @throws SystemException if a system exception occurred 176 */ 177 public static com.liferay.portal.model.ClassName findByPrimaryKey( 178 long classNameId) 179 throws com.liferay.portal.NoSuchClassNameException, 180 com.liferay.portal.kernel.exception.SystemException { 181 return getPersistence().findByPrimaryKey(classNameId); 182 } 183 184 /** 185 * Returns the class name with the primary key or returns <code>null</code> if it could not be found. 186 * 187 * @param classNameId the primary key of the class name 188 * @return the class name, or <code>null</code> if a class name with the primary key could not be found 189 * @throws SystemException if a system exception occurred 190 */ 191 public static com.liferay.portal.model.ClassName fetchByPrimaryKey( 192 long classNameId) 193 throws com.liferay.portal.kernel.exception.SystemException { 194 return getPersistence().fetchByPrimaryKey(classNameId); 195 } 196 197 /** 198 * Returns the class name where value = ? or throws a {@link com.liferay.portal.NoSuchClassNameException} if it could not be found. 199 * 200 * @param value the value 201 * @return the matching class name 202 * @throws com.liferay.portal.NoSuchClassNameException if a matching class name could not be found 203 * @throws SystemException if a system exception occurred 204 */ 205 public static com.liferay.portal.model.ClassName findByValue( 206 java.lang.String value) 207 throws com.liferay.portal.NoSuchClassNameException, 208 com.liferay.portal.kernel.exception.SystemException { 209 return getPersistence().findByValue(value); 210 } 211 212 /** 213 * Returns the class name where value = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 214 * 215 * @param value the value 216 * @return the matching class name, or <code>null</code> if a matching class name could not be found 217 * @throws SystemException if a system exception occurred 218 */ 219 public static com.liferay.portal.model.ClassName fetchByValue( 220 java.lang.String value) 221 throws com.liferay.portal.kernel.exception.SystemException { 222 return getPersistence().fetchByValue(value); 223 } 224 225 /** 226 * Returns the class name where value = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 227 * 228 * @param value the value 229 * @param retrieveFromCache whether to use the finder cache 230 * @return the matching class name, or <code>null</code> if a matching class name could not be found 231 * @throws SystemException if a system exception occurred 232 */ 233 public static com.liferay.portal.model.ClassName fetchByValue( 234 java.lang.String value, boolean retrieveFromCache) 235 throws com.liferay.portal.kernel.exception.SystemException { 236 return getPersistence().fetchByValue(value, retrieveFromCache); 237 } 238 239 /** 240 * Returns all the class names. 241 * 242 * @return the class names 243 * @throws SystemException if a system exception occurred 244 */ 245 public static java.util.List<com.liferay.portal.model.ClassName> findAll() 246 throws com.liferay.portal.kernel.exception.SystemException { 247 return getPersistence().findAll(); 248 } 249 250 /** 251 * Returns a range of all the class names. 252 * 253 * <p> 254 * 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. 255 * </p> 256 * 257 * @param start the lower bound of the range of class names 258 * @param end the upper bound of the range of class names (not inclusive) 259 * @return the range of class names 260 * @throws SystemException if a system exception occurred 261 */ 262 public static java.util.List<com.liferay.portal.model.ClassName> findAll( 263 int start, int end) 264 throws com.liferay.portal.kernel.exception.SystemException { 265 return getPersistence().findAll(start, end); 266 } 267 268 /** 269 * Returns an ordered range of all the class names. 270 * 271 * <p> 272 * 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. 273 * </p> 274 * 275 * @param start the lower bound of the range of class names 276 * @param end the upper bound of the range of class names (not inclusive) 277 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 278 * @return the ordered range of class names 279 * @throws SystemException if a system exception occurred 280 */ 281 public static java.util.List<com.liferay.portal.model.ClassName> findAll( 282 int start, int end, 283 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 284 throws com.liferay.portal.kernel.exception.SystemException { 285 return getPersistence().findAll(start, end, orderByComparator); 286 } 287 288 /** 289 * Removes the class name where value = ? from the database. 290 * 291 * @param value the value 292 * @throws SystemException if a system exception occurred 293 */ 294 public static void removeByValue(java.lang.String value) 295 throws com.liferay.portal.NoSuchClassNameException, 296 com.liferay.portal.kernel.exception.SystemException { 297 getPersistence().removeByValue(value); 298 } 299 300 /** 301 * Removes all the class names from the database. 302 * 303 * @throws SystemException if a system exception occurred 304 */ 305 public static void removeAll() 306 throws com.liferay.portal.kernel.exception.SystemException { 307 getPersistence().removeAll(); 308 } 309 310 /** 311 * Returns the number of class names where value = ?. 312 * 313 * @param value the value 314 * @return the number of matching class names 315 * @throws SystemException if a system exception occurred 316 */ 317 public static int countByValue(java.lang.String value) 318 throws com.liferay.portal.kernel.exception.SystemException { 319 return getPersistence().countByValue(value); 320 } 321 322 /** 323 * Returns the number of class names. 324 * 325 * @return the number of class names 326 * @throws SystemException if a system exception occurred 327 */ 328 public static int countAll() 329 throws com.liferay.portal.kernel.exception.SystemException { 330 return getPersistence().countAll(); 331 } 332 333 public static ClassNamePersistence getPersistence() { 334 if (_persistence == null) { 335 _persistence = (ClassNamePersistence)PortalBeanLocatorUtil.locate(ClassNamePersistence.class.getName()); 336 337 ReferenceRegistry.registerReference(ClassNameUtil.class, 338 "_persistence"); 339 } 340 341 return _persistence; 342 } 343 344 public void setPersistence(ClassNamePersistence persistence) { 345 _persistence = persistence; 346 347 ReferenceRegistry.registerReference(ClassNameUtil.class, "_persistence"); 348 } 349 350 private static ClassNamePersistence _persistence; 351 }