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: import java.util.List;
30:
31: /** Composition Interface
32: * An Composition represents the aggregation of multiple tasks
33: * into a single task. Compositions are referenced by Aggregation PlanElements.
34: *
35: *
36: **/
37:
38: public interface Composition {
39:
40: /** Returns the Aggregation PlanElements of the Tasks that
41: * are being combined
42: * @return List
43: * @see org.cougaar.planning.ldm.plan.Aggregation
44: */
45: List getAggregations();
46:
47: /** Convenienve method that calculates the Tasks that are
48: * being aggregated by looking at all of the Aggregations.
49: * (Aggregation.getTask())
50: * @return List
51: * @see org.cougaar.planning.ldm.plan.Task
52: **/
53: List getParentTasks();
54:
55: /** Returns the newly created task that represents all 'parent' tasks.
56: * The new task should be created as an MPTask.
57: * @return Task
58: * @see org.cougaar.planning.ldm.plan.MPTask
59: */
60: MPTask getCombinedTask();
61:
62: /** Allows the AllocationResult to be properly dispersed among the
63: * original (or parent) tasks.
64: * @return AllocationResultDistributor
65: * @see org.cougaar.planning.ldm.plan.AllocationResultDistributor
66: */
67: AllocationResultDistributor getDistributor();
68:
69: /**Calculate seperate AllocationResults for each parent task of the Composition.
70: * @return TaskScoreTable
71: * @see org.cougaar.planning.ldm.plan.TaskScoreTable
72: */
73: TaskScoreTable calculateDistribution();
74:
75: /** Should all related Aggregations, and the combined task be rescinded
76: * when a single parent task and its Aggregation is rescinded.
77: * When false, and a single 'parent' Aggregation is rescinded,
78: * the infrastructure removes references to that task/Aggregation in the
79: * Composition and the combined MPTask. However, the Composition and combined
80: * task are still valid as are the rest of the parent tasks/Aggregations that
81: * made up the rest of the Composition.
82: * Defaults to true.
83: * set to false by NewComposition.setIsPropagating(isProp);
84: **/
85: boolean isPropagating();
86:
87: }
|