KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: Event.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.Item;
27 import javax.jcr.Ticket;
28
29 /**
30  * All events used by the ObservationManager system are subclassed from this interface
31  * <p/>
32  * <b>Level 2 only</b>
33  * <p/>
34  * For details see the <i>ObservationManager</i> section of the JCR standard document.
35  *
36  * @author Tim Anderson
37  * @author Peeter Piegaze
38  */
39 public interface Event {
40
41   /**
42    * Returns the type of this event. One of:
43    * <ul>
44    * <li>EventType.ITEM_ADDED
45    * <li>EventType.ITEM_CHANGED
46    * <li>EventType.ITEM_REMOVED
47    * <li>EventType.ITEM_VERSIONED
48    * <li>EventType.LABEL_ADDED
49    * <li>EventType.LABEL_REMOVED
50    * <li>EventType.ITEM_LOCKED
51    * <li>EventType.ITEM_UNLOCKED
52    * <li>EventType.LOCK_EXPIRED
53    * </ul>
54    *
55    * @return the type of this event.
56    */
57   public long getType();
58
59   /**
60    * Returns the item connected with this event.
61    *
62    * @return an <code>Item</code>.
63    */
64   public Item getItem();
65
66   /**
67    * Returns the Ticket connected with this event
68    *
69    * @return an <code>Ticket</code>.
70    */
71   public Ticket getTicket();
72 }
73
Popular Tags