01: /*
02: * The contents of this file are subject to the terms of the Common Development
03: * and Distribution License (the License). You may not use this file except in
04: * compliance with the License.
05: *
06: * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
07: * or http://www.netbeans.org/cddl.txt.
08: *
09: * When distributing Covered Code, include this CDDL Header Notice in each file
10: * and include the License file at http://www.netbeans.org/cddl.txt.
11: * If applicable, add the following below the CDDL Header, with the fields
12: * enclosed by brackets [] replaced by your own identifying information:
13: * "Portions Copyrighted [year] [name of copyright owner]"
14: *
15: * The Original Software is NetBeans. The Initial Developer of the Original
16: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17: * Microsystems, Inc. All Rights Reserved.
18: */
19:
20: package org.netbeans.modules.bpel.debugger.spi.plugin.event;
21:
22: import org.netbeans.modules.bpel.debugger.spi.plugin.request.EventRequest;
23:
24: /**
25: * An occurrence in a target BPEL Engine that is of interest to a debugger.
26: * Event is the common superinterface for all events (examples include
27: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.event.BreakpointReachedEvent},
28: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.event.ProcessInstanceCreatedEvent}).
29: * When an event occurs, an instance of Event as a component of an
30: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.event.EventSet}
31: * is enqueued in the
32: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.BpelEngine}'s
33: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.event.EventQueue}.
34: *
35: * @author Alexander Zgursky
36: */
37: public interface Event {
38: /**
39: * Returns the event request that requested this event.
40: *
41: * @return the event request that requested this event. Some events (e.g.
42: * {@link org.netbeans.modules.bpel.debugger.spi.plugin.event.BpelEngineDisconnectedEvent})
43: * may not have a coresponding request and thus will return <code>null</code>.
44: */
45: EventRequest getEventRequest();
46: }
|