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.io.Serializable;
30:
31: import org.cougaar.planning.plugin.legacy.PluginDelegate;
32:
33: /**
34: * A Predictor is an object intended to be available on an
35: * Entity Asset which provides a prediction of how the
36: * associated remote agent WOULD respond if it were allocated a given
37: * task. The predictor should be self-contained, meaning that it should
38: * not require any resources other than those of the provided task and
39: * its own internal resources to provide the allocation response.
40: *
41: * It should be noted that a Predictor is not required for every
42: * Entity Asset : some agents will not provide Predictors.
43: *
44: * It is anticipated that a predictor class will be optionally specified in
45: * a agent's initialization file (<agentname>.ini) which will allow
46: * the agent to pass an instance of the predictor embedded in the
47: * Entity Asset copy of itself when it hooks up with other agents.
48: */
49: public interface Predictor extends Serializable {
50:
51: /**
52: * @return AllocationResult A predictive result for the given task.
53: * @see org.cougaar.planning.ldm.plan.AllocationResult
54: **/
55: AllocationResult Predict(Task for_task, PluginDelegate plugin);
56:
57: }
|