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;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    
026    /**
027     * Provides the local service interface for Lock. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see LockLocalServiceUtil
034     * @see com.liferay.portal.service.base.LockLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.LockLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface LockLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link LockLocalServiceUtil} to access the lock local service. Add custom service methods to {@link com.liferay.portal.service.impl.LockLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the lock to the database. Also notifies the appropriate model listeners.
051            *
052            * @param lock the lock
053            * @return the lock that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.Lock addLock(
058                    com.liferay.portal.model.Lock lock)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new lock with the primary key. Does not add the lock to the database.
063            *
064            * @param lockId the primary key for the new lock
065            * @return the new lock
066            */
067            public com.liferay.portal.model.Lock createLock(long lockId);
068    
069            /**
070            * Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.
071            *
072            * @param lockId the primary key of the lock
073            * @return the lock that was removed
074            * @throws PortalException if a lock with the primary key could not be found
075            * @throws SystemException if a system exception occurred
076            */
077            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
078            public com.liferay.portal.model.Lock deleteLock(long lockId)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            /**
083            * Deletes the lock from the database. Also notifies the appropriate model listeners.
084            *
085            * @param lock the lock
086            * @return the lock that was removed
087            * @throws SystemException if a system exception occurred
088            */
089            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
090            public com.liferay.portal.model.Lock deleteLock(
091                    com.liferay.portal.model.Lock lock)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.LockModelImpl}. 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.LockModelImpl}. 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portal.model.Lock fetchLock(long lockId)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns the lock with the matching UUID and company.
177            *
178            * @param uuid the lock's UUID
179            * @param companyId the primary key of the company
180            * @return the matching lock, or <code>null</code> if a matching lock could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portal.model.Lock fetchLockByUuidAndCompanyId(
185                    java.lang.String uuid, long companyId)
186                    throws com.liferay.portal.kernel.exception.SystemException;
187    
188            /**
189            * Returns the lock with the primary key.
190            *
191            * @param lockId the primary key of the lock
192            * @return the lock
193            * @throws PortalException if a lock with the primary key could not be found
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public com.liferay.portal.model.Lock getLock(long lockId)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            @Override
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public com.liferay.portal.model.PersistedModel getPersistedModel(
204                    java.io.Serializable primaryKeyObj)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Returns the lock with the matching UUID and company.
210            *
211            * @param uuid the lock's UUID
212            * @param companyId the primary key of the company
213            * @return the matching lock
214            * @throws PortalException if a matching lock could not be found
215            * @throws SystemException if a system exception occurred
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public com.liferay.portal.model.Lock getLockByUuidAndCompanyId(
219                    java.lang.String uuid, long companyId)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Returns a range of all the locks.
225            *
226            * <p>
227            * 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.LockModelImpl}. 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.
228            * </p>
229            *
230            * @param start the lower bound of the range of locks
231            * @param end the upper bound of the range of locks (not inclusive)
232            * @return the range of locks
233            * @throws SystemException if a system exception occurred
234            */
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public java.util.List<com.liferay.portal.model.Lock> getLocks(int start,
237                    int end) throws com.liferay.portal.kernel.exception.SystemException;
238    
239            /**
240            * Returns the number of locks.
241            *
242            * @return the number of locks
243            * @throws SystemException if a system exception occurred
244            */
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public int getLocksCount()
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            /**
250            * Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
251            *
252            * @param lock the lock
253            * @return the lock that was updated
254            * @throws SystemException if a system exception occurred
255            */
256            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
257            public com.liferay.portal.model.Lock updateLock(
258                    com.liferay.portal.model.Lock lock)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            /**
262            * Returns the Spring bean ID for this bean.
263            *
264            * @return the Spring bean ID for this bean
265            */
266            public java.lang.String getBeanIdentifier();
267    
268            /**
269            * Sets the Spring bean ID for this bean.
270            *
271            * @param beanIdentifier the Spring bean ID for this bean
272            */
273            public void setBeanIdentifier(java.lang.String beanIdentifier);
274    
275            public void clear()
276                    throws com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public com.liferay.portal.model.Lock getLock(java.lang.String className,
280                    long key)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public com.liferay.portal.model.Lock getLock(java.lang.String className,
286                    java.lang.String key)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public boolean hasLock(long userId, java.lang.String className, long key)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public boolean hasLock(long userId, java.lang.String className,
296                    java.lang.String key)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public boolean isLocked(java.lang.String className, long key)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public boolean isLocked(java.lang.String className, java.lang.String key)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            public com.liferay.portal.model.Lock lock(long userId,
308                    java.lang.String className, long key, java.lang.String owner,
309                    boolean inheritable, long expirationTime)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public com.liferay.portal.model.Lock lock(long userId,
314                    java.lang.String className, java.lang.String key,
315                    java.lang.String owner, boolean inheritable, long expirationTime)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
320            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
321            public com.liferay.portal.model.Lock lock(java.lang.String className,
322                    java.lang.String key, java.lang.String owner)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            /**
326            * @deprecated As of 6.2.0, replaced by {@link #lock(String, String,
327            String)}
328            */
329            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
330            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
331            public com.liferay.portal.model.Lock lock(java.lang.String className,
332                    java.lang.String key, java.lang.String owner, boolean retrieveFromCache)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
336            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
337            public com.liferay.portal.model.Lock lock(java.lang.String className,
338                    java.lang.String key, java.lang.String expectedOwner,
339                    java.lang.String updatedOwner)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            /**
343            * @deprecated As of 6.2.0, replaced by {@link #lock(String, String, String,
344            String)}
345            */
346            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
347            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
348            public com.liferay.portal.model.Lock lock(java.lang.String className,
349                    java.lang.String key, java.lang.String expectedOwner,
350                    java.lang.String updatedOwner, boolean retrieveFromCache)
351                    throws com.liferay.portal.kernel.exception.SystemException;
352    
353            public com.liferay.portal.model.Lock refresh(java.lang.String uuid,
354                    long companyId, long expirationTime)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            public void unlock(java.lang.String className, long key)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            public void unlock(java.lang.String className, java.lang.String key)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
365            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
366            public void unlock(java.lang.String className, java.lang.String key,
367                    java.lang.String owner)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            /**
371            * @deprecated As of 6.2.0, replaced by {@link #unlock(String, String,
372            String)}
373            */
374            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
375            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
376            public void unlock(java.lang.String className, java.lang.String key,
377                    java.lang.String owner, boolean retrieveFromCache)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    }