1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.lock.service;
24  
25  import com.liferay.lock.model.Lock;
26  import com.liferay.portal.PortalException;
27  import com.liferay.portal.SystemException;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="LockService.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Brian Wing Shun Chan
34   *
35   */
36  @Transactional(rollbackFor = {PortalException.class, SystemException.class})
37  public interface LockService {
38  
39      public void clear();
40  
41      public Lock getLock(String className, Comparable<?> pk)
42          throws PortalException;
43  
44      public boolean hasLock(String className, Comparable<?> pk, long userId);
45  
46      public boolean isLocked(String className, Comparable<?> pk);
47  
48      public Lock lock(
49              String className, Comparable<?> pk, long userId, String owner,
50              long expirationTime)
51          throws PortalException;
52  
53      public Lock lock(
54              String className, Comparable<?> pk, long userId, String owner,
55              boolean inheritable, long expirationTime)
56          throws PortalException;
57  
58      public Lock refresh(String uuid, long expirationTime)
59          throws PortalException;
60  
61      public void unlock(String className, Comparable<?> pk);
62  
63  }