KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > jcr > observation > LockEvent


1 /*
2  * $Id: LockEvent.java,v 1.2 2004/07/24 00:16:23 benjmestrallet Exp $
3  *
4  * Copyright 2002-2004 Day Management AG, Switzerland.
5  *
6  * Licensed under the Day RI License, Version 2.0 (the "License"),
7  * as a reference implementation of the following specification:
8  *
9  * Content Repository API for Java Technology, revision 0.12
10  * <http://www.jcp.org/en/jsr/detail?id=170>
11  *
12  * You may not use this file except in compliance with the License.
13  * You may obtain a copy of the License files at
14  *
15  * http://www.day.com/content/en/licenses/day-ri-license-2.0
16  * http://www.apache.org/licenses/LICENSE-2.0
17  *
18  * Unless required by applicable law or agreed to in writing, software
19  * distributed under the License is distributed on an "AS IS" BASIS,
20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  * See the License for the specific language governing permissions and
22  * limitations under the License.
23  */
24 package javax.jcr.observation;
25
26 import javax.jcr.lock.Lock;
27
28 /**
29  * A subclass of <code>Event</code> representing a "locking" event.
30  * <p/>
31  * <b>Level 2 only</b></code>
32  * <p/>
33  * Will always
34  * be one of the following types:
35  * <ul>
36  * <li><code>EventType.ITEM_LOCKED</code>
37  * <li><code>EventType.ITEM_UNLOCKED</code>
38  * <li><code>EventType.LOCK_EXPIRED</code>
39  * </ul>
40  * For details see the <i>ObservationManager</i> section of the JCR standard document.
41  *
42  * @author Tim Anderson
43  * @author Peeter Piegaze
44  */
45 public interface LockEvent extends Event {
46
47   /**
48    * Returns the lock object associated with the locking event.
49    *
50    * @return a <code>Lock</code> object.
51    */
52   public Lock getLock();
53 }
54
Popular Tags