01: /*
02: * <copyright>
03: *
04: * Copyright 2003-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: package org.cougaar.lib.vishnu.client;
27:
28: import java.util.Collection;
29: import java.util.Enumeration;
30: import java.util.List;
31: import org.w3c.dom.Document;
32:
33: /**
34: * Defines the lifecycle of a Scheduler Mode, one of External, Internal, or Direct.
35: * <p>
36: * A mode has to deal with four basic steps (setup, initialize, prepare data, run).
37: * <p>
38: * It also has to deal with removed tasks, since the scheduler may have state associated
39: * with past tasks. <p>
40: *
41: * Paired with the ModeListener.
42: * @see ModeListener
43: */
44: public interface SchedulerLifecycle {
45: /** create scheduler, if needed */
46: void setupScheduler();
47:
48: /** tell Scheduler about the problem format */
49: void initializeWithFormat();
50:
51: /** tell Scheduler about tasks and assets to use */
52: void prepareData(List stuffToSend, Document objectFormatDoc);
53:
54: /** run Scheduler, parse assignments, call ResultListener methods to create plan elements */
55: void run();
56:
57: /** tell Scheduler about tasks that have been rescinded */
58: void handleRemovedTasks(Enumeration tasks);
59:
60: void unfreezeTasks(Collection tasks);
61:
62: Collection getTaskKeys();
63:
64: /** queries the scheduler to get a full specification of the problem
65: * (including specs, logic, gaspecs, objects, assignments, etc)
66: */
67: String dumpToXML();
68: }
|