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