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.planning.ldm.plan;
28:
29: /** NewExpansion Interface
30: * Allows access to the single sub-task's allocation result information
31: * used to aggregate this Expansion's latest reported allocationresult
32: *
33: *
34: **/
35:
36: public interface NewExpansion extends Expansion {
37:
38: /** Called by an Expander Plugin to get the latest copy of the allocationresults
39: * for each subtask.
40: * Information is stored in a List which contains a SubTaskResult for each subtask.
41: * Each of the SubTaskResult objects contain the following information:
42: * Task - the subtask, boolean - whether the result changed,
43: * AllocationResult - the result used by the aggregator for this sub-task.
44: * The boolean indicates whether the AllocationResult changed since the
45: * last time the collection was cleared by the plugin (which should be
46: * the last time the plugin looked at the list).
47: * NOTE!!! This accessor should only be called once in a plugin execute cycle as
48: * the list will be cleared as soon as this accessor is called. The information container
49: * in the return list should be directly related to an update of the reportedAllocationResult
50: * slot on the Expansion that the plugin woke up on.
51: * @return List
52: */
53: SubtaskResults getSubTaskResults();
54:
55: }
|