01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.lib.callback;
28:
29: import org.cougaar.planning.ldm.plan.Task;
30:
31: /**
32: * Listener for use with the record/playback system.
33: *
34: * Listens for tasks that came from outside (alien!) clusters.
35: * I.e. tasks expanded by the cluster will *not* be heard.
36: *
37: * All the plugin should have to implement is interestingTask and handleTask.
38: */
39:
40: public interface UTILAlienListener extends UTILFilterCallbackListener {
41: /**
42: * Defines tasks you find interesting.
43: * @param t Task to check for interest
44: * @return boolean true if task is interesting
45: */
46: boolean interestingTask(Task t);
47:
48: /**
49: * If the listener is a descendant of UTILPluginAdapter,
50: * should not have to write anything,
51: * since it already has a method with this name.
52: *
53: * @see org.cougaar.lib.filter.UTILPluginAdapter#getClusterName
54: */
55: String getClusterName();
56:
57: /**
58: * What the plugin does when it finds an Alien task.
59: */
60: void handleTask(Task t);
61: }
|