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: /* ConstraintEvent objects can be used to denote
27: * either constraining or constrained events
28: */
29:
30: package org.cougaar.planning.ldm.plan;
31:
32: public interface ConstraintEvent {
33: /**
34: * This value is used to denote an unknown aspect value in all
35: * constraint events.
36: **/
37: double NOVALUE = Double.NaN;
38:
39: /* getValue returns the allocation result of the
40: * aspect when the task is constraining or
41: * the preferred value of the aspect when the
42: * task is constrained. isConstraining is true
43: * when task is constraining, false when task is
44: * constrained.
45: * @return the value of this ConstrainEvent. NOVALUE is returned if
46: * the value is not known. For example, the value for a constrained
47: * task that has not yet been disposed will be NOVALUE.
48: */
49: double getValue();
50:
51: /* getResultValue returns the allocation result of the
52: * aspect without regard to whether the event isConstraining()
53: * @return the value of this ConstrainEvent. NOVALUE is returned if
54: * the value is not known. For example, the value for a constrained
55: * task that has not yet been disposed will be NOVALUE.
56: */
57: double getResultValue();
58:
59: /**
60: * The aspect involved in this end of the constraint.
61: * @return the aspect type of the preference or allocation result.
62: **/
63: int getAspectType();
64:
65: /**
66: * Return the task, if any. AbsoluteConstraintEvents have no task.
67: * @return the task. null is returned for absolute constraints.
68: **/
69: Task getTask();
70:
71: /**
72: * Tests if this is a constraining (vs. constrained) event.
73: **/
74: boolean isConstraining();
75: }
|