01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18: package org.apache.lenya.transaction;
19:
20: /**
21: * Object that can be locked.
22: *
23: * @version $Id: Lockable.java 473861 2006-11-12 03:51:14Z gregor $
24: */
25: public interface Lockable {
26:
27: /**
28: * Locks this object.
29: * @throws TransactionException if an error occurs.
30: */
31: void lock() throws TransactionException;
32:
33: /**
34: * Unlocks this object.
35: * @throws TransactionException if an error occurs.
36: */
37: void unlock() throws TransactionException;
38:
39: /**
40: * @return if this object is locked.
41: * @throws TransactionException if an error occurs.
42: */
43: boolean isLocked() throws TransactionException;
44:
45: /**
46: * @return The lock which is held by this object.
47: */
48: Lock getLock();
49:
50: }
|