001    /**
002     * Copyright (c) 2000-present 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            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.Lock addLock(
057                    com.liferay.portal.model.Lock lock);
058    
059            public void clear();
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 from the database. Also notifies the appropriate model listeners.
071            *
072            * @param lock the lock
073            * @return the lock that was removed
074            */
075            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
076            public com.liferay.portal.model.Lock deleteLock(
077                    com.liferay.portal.model.Lock lock);
078    
079            /**
080            * Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.
081            *
082            * @param lockId the primary key of the lock
083            * @return the lock that was removed
084            * @throws PortalException if a lock with the primary key could not be found
085            */
086            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
087            public com.liferay.portal.model.Lock deleteLock(long lockId)
088                    throws com.liferay.portal.kernel.exception.PortalException;
089    
090            /**
091            * @throws PortalException
092            */
093            @Override
094            public com.liferay.portal.model.PersistedModel deletePersistedModel(
095                    com.liferay.portal.model.PersistedModel persistedModel)
096                    throws com.liferay.portal.kernel.exception.PortalException;
097    
098            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            */
106            public <T> java.util.List<T> dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
108    
109            /**
110            * Performs a dynamic query on the database and returns a range of the matching rows.
111            *
112            * <p>
113            * 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.
114            * </p>
115            *
116            * @param dynamicQuery the dynamic query
117            * @param start the lower bound of the range of model instances
118            * @param end the upper bound of the range of model instances (not inclusive)
119            * @return the range of matching rows
120            */
121            public <T> java.util.List<T> dynamicQuery(
122                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
123                    int end);
124    
125            /**
126            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
127            *
128            * <p>
129            * 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.
130            * </p>
131            *
132            * @param dynamicQuery the dynamic query
133            * @param start the lower bound of the range of model instances
134            * @param end the upper bound of the range of model instances (not inclusive)
135            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
136            * @return the ordered range of matching rows
137            */
138            public <T> java.util.List<T> dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
142    
143            /**
144            * Returns the number of rows matching the dynamic query.
145            *
146            * @param dynamicQuery the dynamic query
147            * @return the number of rows matching the dynamic query
148            */
149            public long dynamicQueryCount(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
151    
152            /**
153            * Returns the number of rows matching the dynamic query.
154            *
155            * @param dynamicQuery the dynamic query
156            * @param projection the projection to apply to the query
157            * @return the number of rows matching the dynamic query
158            */
159            public long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
161                    com.liferay.portal.kernel.dao.orm.Projection projection);
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.Lock fetchLock(long lockId);
165    
166            /**
167            * Returns the lock with the matching UUID and company.
168            *
169            * @param uuid the lock's UUID
170            * @param companyId the primary key of the company
171            * @return the matching lock, or <code>null</code> if a matching lock could not be found
172            */
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.Lock fetchLockByUuidAndCompanyId(
175                    java.lang.String uuid, long companyId);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
179    
180            /**
181            * Returns the Spring bean ID for this bean.
182            *
183            * @return the Spring bean ID for this bean
184            */
185            public java.lang.String getBeanIdentifier();
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portal.model.Lock getLock(java.lang.String className,
189                    long key) throws com.liferay.portal.kernel.exception.PortalException;
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portal.model.Lock getLock(java.lang.String className,
193                    java.lang.String key)
194                    throws com.liferay.portal.kernel.exception.PortalException;
195    
196            /**
197            * Returns the lock with the primary key.
198            *
199            * @param lockId the primary key of the lock
200            * @return the lock
201            * @throws PortalException if a lock with the primary key could not be found
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public com.liferay.portal.model.Lock getLock(long lockId)
205                    throws com.liferay.portal.kernel.exception.PortalException;
206    
207            /**
208            * Returns the lock with the matching UUID and company.
209            *
210            * @param uuid the lock's UUID
211            * @param companyId the primary key of the company
212            * @return the matching lock
213            * @throws PortalException if a matching lock could not be found
214            */
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public com.liferay.portal.model.Lock getLockByUuidAndCompanyId(
217                    java.lang.String uuid, long companyId)
218                    throws com.liferay.portal.kernel.exception.PortalException;
219    
220            /**
221            * Returns a range of all the locks.
222            *
223            * <p>
224            * 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.
225            * </p>
226            *
227            * @param start the lower bound of the range of locks
228            * @param end the upper bound of the range of locks (not inclusive)
229            * @return the range of locks
230            */
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public java.util.List<com.liferay.portal.model.Lock> getLocks(int start,
233                    int end);
234    
235            /**
236            * Returns the number of locks.
237            *
238            * @return the number of locks
239            */
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public int getLocksCount();
242    
243            @Override
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public com.liferay.portal.model.PersistedModel getPersistedModel(
246                    java.io.Serializable primaryKeyObj)
247                    throws com.liferay.portal.kernel.exception.PortalException;
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public boolean hasLock(long userId, java.lang.String className,
251                    java.lang.String key);
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public boolean hasLock(long userId, java.lang.String className, long key);
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public boolean isLocked(java.lang.String className, java.lang.String key);
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public boolean isLocked(java.lang.String className, long key);
261    
262            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
263            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
264            public com.liferay.portal.model.Lock lock(java.lang.String className,
265                    java.lang.String key, java.lang.String expectedOwner,
266                    java.lang.String updatedOwner);
267    
268            /**
269            * @deprecated As of 6.2.0, replaced by {@link #lock(String, String, String,
270            String)}
271            */
272            @java.lang.Deprecated
273            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
274            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
275            public com.liferay.portal.model.Lock lock(java.lang.String className,
276                    java.lang.String key, java.lang.String expectedOwner,
277                    java.lang.String updatedOwner, boolean retrieveFromCache);
278    
279            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
280            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
281            public com.liferay.portal.model.Lock lock(java.lang.String className,
282                    java.lang.String key, java.lang.String owner);
283    
284            /**
285            * @deprecated As of 6.2.0, replaced by {@link #lock(String, String,
286            String)}
287            */
288            @java.lang.Deprecated
289            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
290            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
291            public com.liferay.portal.model.Lock lock(java.lang.String className,
292                    java.lang.String key, java.lang.String owner, boolean retrieveFromCache);
293    
294            public com.liferay.portal.model.Lock lock(long userId,
295                    java.lang.String className, java.lang.String key,
296                    java.lang.String owner, boolean inheritable, long expirationTime)
297                    throws com.liferay.portal.kernel.exception.PortalException;
298    
299            public com.liferay.portal.model.Lock lock(long userId,
300                    java.lang.String className, long key, java.lang.String owner,
301                    boolean inheritable, long expirationTime)
302                    throws com.liferay.portal.kernel.exception.PortalException;
303    
304            public com.liferay.portal.model.Lock refresh(java.lang.String uuid,
305                    long companyId, long expirationTime)
306                    throws com.liferay.portal.kernel.exception.PortalException;
307    
308            /**
309            * Sets the Spring bean ID for this bean.
310            *
311            * @param beanIdentifier the Spring bean ID for this bean
312            */
313            public void setBeanIdentifier(java.lang.String beanIdentifier);
314    
315            public void unlock(java.lang.String className, long key);
316    
317            public void unlock(java.lang.String className, java.lang.String key);
318    
319            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
320            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
321            public void unlock(java.lang.String className, java.lang.String key,
322                    java.lang.String owner);
323    
324            /**
325            * @deprecated As of 6.2.0, replaced by {@link #unlock(String, String,
326            String)}
327            */
328            @java.lang.Deprecated
329            @com.liferay.portal.kernel.dao.jdbc.aop.MasterDataSource
330            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
331            public void unlock(java.lang.String className, java.lang.String key,
332                    java.lang.String owner, boolean retrieveFromCache);
333    
334            /**
335            * Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
336            *
337            * @param lock the lock
338            * @return the lock that was updated
339            */
340            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
341            public com.liferay.portal.model.Lock updateLock(
342                    com.liferay.portal.model.Lock lock);
343    }