001    /**
002     * Copyright (c) 2000-2010 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;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the lock local service. This utility wraps {@link com.liferay.portal.service.impl.LockLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LockLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see LockLocalService
032     * @see com.liferay.portal.service.base.LockLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LockLocalServiceImpl
034     * @generated
035     */
036    public class LockLocalServiceUtil {
037            /**
038            * Adds the lock to the database. Also notifies the appropriate model listeners.
039            *
040            * @param lock the lock to add
041            * @return the lock that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.Lock addLock(
045                    com.liferay.portal.model.Lock lock)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addLock(lock);
048            }
049    
050            /**
051            * Creates a new lock with the primary key. Does not add the lock to the database.
052            *
053            * @param lockId the primary key for the new lock
054            * @return the new lock
055            */
056            public static com.liferay.portal.model.Lock createLock(long lockId) {
057                    return getService().createLock(lockId);
058            }
059    
060            /**
061            * Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.
062            *
063            * @param lockId the primary key of the lock to delete
064            * @throws PortalException if a lock with the primary key could not be found
065            * @throws SystemException if a system exception occurred
066            */
067            public static void deleteLock(long lockId)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException {
070                    getService().deleteLock(lockId);
071            }
072    
073            /**
074            * Deletes the lock from the database. Also notifies the appropriate model listeners.
075            *
076            * @param lock the lock to delete
077            * @throws SystemException if a system exception occurred
078            */
079            public static void deleteLock(com.liferay.portal.model.Lock lock)
080                    throws com.liferay.portal.kernel.exception.SystemException {
081                    getService().deleteLock(lock);
082            }
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public static java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException {
095                    return getService().dynamicQuery(dynamicQuery);
096            }
097    
098            /**
099            * Performs a dynamic query on the database and returns a range of the matching rows.
100            *
101            * <p>
102            * 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.
103            * </p>
104            *
105            * @param dynamicQuery the dynamic query to search with
106            * @param start the lower bound of the range of model instances to return
107            * @param end the upper bound of the range of model instances to return (not inclusive)
108            * @return the range of matching rows
109            * @throws SystemException if a system exception occurred
110            */
111            @SuppressWarnings("rawtypes")
112            public static java.util.List dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
114                    int end) throws com.liferay.portal.kernel.exception.SystemException {
115                    return getService().dynamicQuery(dynamicQuery, start, end);
116            }
117    
118            /**
119            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query to search with
126            * @param start the lower bound of the range of model instances to return
127            * @param end the upper bound of the range of model instances to return (not inclusive)
128            * @param orderByComparator the comparator to order the results by
129            * @return the ordered range of matching rows
130            * @throws SystemException if a system exception occurred
131            */
132            @SuppressWarnings("rawtypes")
133            public static java.util.List dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end,
136                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
137                    throws com.liferay.portal.kernel.exception.SystemException {
138                    return getService()
139                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
140            }
141    
142            /**
143            * Counts the number of rows that match the dynamic query.
144            *
145            * @param dynamicQuery the dynamic query to search with
146            * @return the number of rows that match the dynamic query
147            * @throws SystemException if a system exception occurred
148            */
149            public static long dynamicQueryCount(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
151                    throws com.liferay.portal.kernel.exception.SystemException {
152                    return getService().dynamicQueryCount(dynamicQuery);
153            }
154    
155            /**
156            * Gets the lock with the primary key.
157            *
158            * @param lockId the primary key of the lock to get
159            * @return the lock
160            * @throws PortalException if a lock with the primary key could not be found
161            * @throws SystemException if a system exception occurred
162            */
163            public static com.liferay.portal.model.Lock getLock(long lockId)
164                    throws com.liferay.portal.kernel.exception.PortalException,
165                            com.liferay.portal.kernel.exception.SystemException {
166                    return getService().getLock(lockId);
167            }
168    
169            /**
170            * Gets a range of all the locks.
171            *
172            * <p>
173            * 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.
174            * </p>
175            *
176            * @param start the lower bound of the range of locks to return
177            * @param end the upper bound of the range of locks to return (not inclusive)
178            * @return the range of locks
179            * @throws SystemException if a system exception occurred
180            */
181            public static java.util.List<com.liferay.portal.model.Lock> getLocks(
182                    int start, int end)
183                    throws com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getLocks(start, end);
185            }
186    
187            /**
188            * Gets the number of locks.
189            *
190            * @return the number of locks
191            * @throws SystemException if a system exception occurred
192            */
193            public static int getLocksCount()
194                    throws com.liferay.portal.kernel.exception.SystemException {
195                    return getService().getLocksCount();
196            }
197    
198            /**
199            * Updates the lock in the database. Also notifies the appropriate model listeners.
200            *
201            * @param lock the lock to update
202            * @return the lock that was updated
203            * @throws SystemException if a system exception occurred
204            */
205            public static com.liferay.portal.model.Lock updateLock(
206                    com.liferay.portal.model.Lock lock)
207                    throws com.liferay.portal.kernel.exception.SystemException {
208                    return getService().updateLock(lock);
209            }
210    
211            /**
212            * Updates the lock in the database. Also notifies the appropriate model listeners.
213            *
214            * @param lock the lock to update
215            * @param merge whether to merge the lock with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
216            * @return the lock that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.Lock updateLock(
220                    com.liferay.portal.model.Lock lock, boolean merge)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateLock(lock, merge);
223            }
224    
225            public static void clear()
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    getService().clear();
228            }
229    
230            public static com.liferay.portal.model.Lock getLock(
231                    java.lang.String className, long key)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException {
234                    return getService().getLock(className, key);
235            }
236    
237            public static com.liferay.portal.model.Lock getLock(
238                    java.lang.String className, java.lang.String key)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException {
241                    return getService().getLock(className, key);
242            }
243    
244            public static boolean hasLock(long userId, java.lang.String className,
245                    long key)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    return getService().hasLock(userId, className, key);
249            }
250    
251            public static boolean hasLock(long userId, java.lang.String className,
252                    java.lang.String key)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException {
255                    return getService().hasLock(userId, className, key);
256            }
257    
258            public static boolean isLocked(java.lang.String className, long key)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException {
261                    return getService().isLocked(className, key);
262            }
263    
264            public static boolean isLocked(java.lang.String className,
265                    java.lang.String key)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService().isLocked(className, key);
269            }
270    
271            public static com.liferay.portal.model.Lock lock(long userId,
272                    java.lang.String className, long key, java.lang.String owner,
273                    boolean inheritable, long expirationTime)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService()
277                                       .lock(userId, className, key, owner, inheritable,
278                            expirationTime);
279            }
280    
281            public static com.liferay.portal.model.Lock lock(long userId,
282                    java.lang.String className, java.lang.String key,
283                    java.lang.String owner, boolean inheritable, long expirationTime)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService()
287                                       .lock(userId, className, key, owner, inheritable,
288                            expirationTime);
289            }
290    
291            public static com.liferay.portal.model.Lock refresh(java.lang.String uuid,
292                    long expirationTime)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    return getService().refresh(uuid, expirationTime);
296            }
297    
298            public static void unlock(java.lang.String className, long key)
299                    throws com.liferay.portal.kernel.exception.SystemException {
300                    getService().unlock(className, key);
301            }
302    
303            public static void unlock(java.lang.String className, java.lang.String key)
304                    throws com.liferay.portal.kernel.exception.SystemException {
305                    getService().unlock(className, key);
306            }
307    
308            public static LockLocalService getService() {
309                    if (_service == null) {
310                            _service = (LockLocalService)PortalBeanLocatorUtil.locate(LockLocalService.class.getName());
311                    }
312    
313                    return _service;
314            }
315    
316            public void setService(LockLocalService service) {
317                    _service = service;
318            }
319    
320            private static LockLocalService _service;
321    }