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