001    /**
002     * Copyright (c) 2000-2011 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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * The interface for the lock local service.
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 LockLocalServiceUtil
032     * @see com.liferay.portal.service.base.LockLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LockLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface LockLocalService extends PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * 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.
043             */
044    
045            /**
046            * Adds the lock to the database. Also notifies the appropriate model listeners.
047            *
048            * @param lock the lock
049            * @return the lock that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.Lock addLock(
053                    com.liferay.portal.model.Lock lock)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new lock with the primary key. Does not add the lock to the database.
058            *
059            * @param lockId the primary key for the new lock
060            * @return the new lock
061            */
062            public com.liferay.portal.model.Lock createLock(long lockId);
063    
064            /**
065            * Deletes the lock with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param lockId the primary key of the lock
068            * @throws PortalException if a lock with the primary key could not be found
069            * @throws SystemException if a system exception occurred
070            */
071            public void deleteLock(long lockId)
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException;
074    
075            /**
076            * Deletes the lock from the database. Also notifies the appropriate model listeners.
077            *
078            * @param lock the lock
079            * @throws SystemException if a system exception occurred
080            */
081            public void deleteLock(com.liferay.portal.model.Lock lock)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query
104            * @param start the lower bound of the range of model instances
105            * @param end the upper bound of the range of model instances (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Returns the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Returns the lock with the primary key.
148            *
149            * @param lockId the primary key of the lock
150            * @return the lock
151            * @throws PortalException if a lock with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portal.model.Lock getLock(long lockId)
156                    throws com.liferay.portal.kernel.exception.PortalException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public com.liferay.portal.model.PersistedModel getPersistedModel(
161                    java.io.Serializable primaryKeyObj)
162                    throws com.liferay.portal.kernel.exception.PortalException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            /**
166            * Returns a range of all the locks.
167            *
168            * <p>
169            * 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.
170            * </p>
171            *
172            * @param start the lower bound of the range of locks
173            * @param end the upper bound of the range of locks (not inclusive)
174            * @return the range of locks
175            * @throws SystemException if a system exception occurred
176            */
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public java.util.List<com.liferay.portal.model.Lock> getLocks(int start,
179                    int end) throws com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the number of locks.
183            *
184            * @return the number of locks
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public int getLocksCount()
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
193            *
194            * @param lock the lock
195            * @return the lock that was updated
196            * @throws SystemException if a system exception occurred
197            */
198            public com.liferay.portal.model.Lock updateLock(
199                    com.liferay.portal.model.Lock lock)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the lock in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
204            *
205            * @param lock the lock
206            * @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.
207            * @return the lock that was updated
208            * @throws SystemException if a system exception occurred
209            */
210            public com.liferay.portal.model.Lock updateLock(
211                    com.liferay.portal.model.Lock lock, boolean merge)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            /**
215            * Returns the Spring bean ID for this bean.
216            *
217            * @return the Spring bean ID for this bean
218            */
219            public java.lang.String getBeanIdentifier();
220    
221            /**
222            * Sets the Spring bean ID for this bean.
223            *
224            * @param beanIdentifier the Spring bean ID for this bean
225            */
226            public void setBeanIdentifier(java.lang.String beanIdentifier);
227    
228            public void clear()
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public com.liferay.portal.model.Lock getLock(java.lang.String className,
233                    long key)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public com.liferay.portal.model.Lock getLock(java.lang.String className,
239                    java.lang.String key)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException;
242    
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public com.liferay.portal.model.Lock getLockByUuid(java.lang.String uuid)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public boolean hasLock(long userId, java.lang.String className, long key)
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public boolean hasLock(long userId, java.lang.String className,
254                    java.lang.String key)
255                    throws com.liferay.portal.kernel.exception.SystemException;
256    
257            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258            public boolean isLocked(java.lang.String className, long key)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public boolean isLocked(java.lang.String className, java.lang.String key)
263                    throws com.liferay.portal.kernel.exception.SystemException;
264    
265            public com.liferay.portal.model.Lock lock(long userId,
266                    java.lang.String className, long key, java.lang.String owner,
267                    boolean inheritable, long expirationTime)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public com.liferay.portal.model.Lock lock(long userId,
272                    java.lang.String className, java.lang.String key,
273                    java.lang.String owner, boolean inheritable, long expirationTime)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public com.liferay.portal.model.Lock lock(java.lang.String className,
278                    java.lang.String key, java.lang.String owner, boolean retrieveFromCache)
279                    throws com.liferay.portal.kernel.exception.SystemException;
280    
281            public com.liferay.portal.model.Lock lock(java.lang.String className,
282                    java.lang.String key, java.lang.String expectedOwner,
283                    java.lang.String updatedOwner, boolean retrieveFromCache)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            public com.liferay.portal.model.Lock refresh(java.lang.String uuid,
287                    long expirationTime)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void unlock(java.lang.String className, long key)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            public void unlock(java.lang.String className, java.lang.String key)
295                    throws com.liferay.portal.kernel.exception.SystemException;
296    
297            public void unlock(java.lang.String className, java.lang.String key,
298                    java.lang.String owner, boolean retrieveFromCache)
299                    throws com.liferay.portal.kernel.exception.SystemException;
300    }