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: /** BulkEstimate Interface
32: * A BulkEstimate is similar to but not a subclass of PlanElement.
33: * A BulkEstimate allows for a Plugin to specify a Task with a collection
34: * of Preference sets and get back a collection of AllocationResults.
35: * Each AllocationResult will represent the results of allocating the Task
36: * with one of the Preference sets.
37: *
38: **/
39:
40: public interface BulkEstimate {
41: /** @return Task The task to be allocated */
42: Task getTask();
43:
44: /** @return List The collection of preference sets. Each set will be
45: * represented by a Preference Array.
46: */
47: List getPreferenceSets();
48:
49: /** @return AllocationResult[] The Array of AllocationResults.
50: * Note that this collection will be changing until isComplete()
51: */
52: AllocationResult[] getAllocationResults();
53:
54: /** @return boolean Will be set to true once all of the AllocationResults
55: * for each preference set have been gathered.
56: */
57: boolean isComplete();
58:
59: /** @return double The confidence rating of each AllocationResult that
60: * must be reached before the result is valid and the next preference set
61: * can be tested. The confidence rating should be between 0.0 and 1.0 with
62: * 1.0 being the most complete of allocations.
63: */
64: double getConfidenceRating();
65:
66: }
|