001: /*
002: * <copyright>
003: *
004: * Copyright 1997-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026:
027: package org.cougaar.planning.ldm.plan;
028:
029: /**
030: * NewConstraint extends Constraint and provides
031: * setter methods for building valid Constraint objects.
032: *
033: *
034: **/
035: public interface NewConstraint extends Constraint {
036: /**
037: * setConstrainingTask allows you to set the constraining task.
038: * This should be done exactly once for a particular constraint
039: * that is not an absolute constraint and must be done before the
040: * constraint is added to the workflow.
041: * @param task the task that is constraining another task.
042: **/
043: void setConstrainingTask(Task task);
044:
045: /**
046: * setConstrainingAspect allows you to set the constraining
047: * aspect. For non-temporal constraints both constraining and
048: * constrained aspects must be the same For temporal aspects they
049: * can be different (as long as they are both temporal aspects).
050: * This should be done exactly once for a particular constraint
051: * that is not an absolute constraint and must be done before the
052: * constraint is added to the workflow.
053: * @param aspect the aspect of the constraining task.
054: **/
055: void setConstrainingAspect(int aspect);
056:
057: /**
058: * Set an absolute value as the constraining aspect value. The
059: * constrained task's preferences can be adjusted to fulfill the
060: * constraint. The constraining value of an absolute constraint
061: * may be changed at any time. The new value will be used in
062: * subsequent constraint violation checks and in setting the
063: * preferences of the constrained task. The constraining value is
064: * added to the offset value, but it is not necessary to use both
065: * features.
066: *
067: * The use of this method is mutually exclusive of using
068: * setConstrainingTask. Use one or the other, not both for a
069: * particular Constraint.
070: * @param value the value against which the constrained value is tested.
071: **/
072: void setAbsoluteConstrainingValue(double value);
073:
074: /**
075: * setConstrainedTask allows you to set the constrained task.
076: * This should be done exactly once for a particular constraint
077: * and must be done before the constraint is added to the
078: * workflow.
079: * @param task is the task that is to be adjusted to satisfy the
080: * constraint.
081: **/
082: void setConstrainedTask(Task task);
083:
084: /**
085: * setConstrainedAspect allows you to set the constrained
086: * aspect. For non-temporal constraints both constraining and
087: * constrained aspects must be the same. For temporal aspects
088: * they can be different, but must be temporal aspects.
089: * This method should be called once before the constraint is
090: * added to the workflow.
091: * @param aspect the aspect type of the allocation result to be
092: * tested.
093: **/
094: void setConstrainedAspect(int aspect);
095:
096: /**
097: * Specifies how the aspect values should be constrained. The
098: * order should be COINCIDENT, BEFORE, or AFTER for temporal
099: * constraints, GREATERTHAN, LESSTHAN, or EQUALTO for
100: * non-temporal constraints.
101: * <PRE> mynewconstraint.setConstraintOrder(BEFORE); </PRE>
102: * @param order - Should be COINCIDENT, BEFORE, AFTER,
103: * GREATERTHAN, LESSTHAN or EQUALTO.
104: **/
105: void setConstraintOrder(int order);
106:
107: /**
108: * setOffsetOfConstraint allows you to set the offset of the
109: * Constraint. The offset is added to the constraining aspect
110: * value before it is compared to the constrained aspect value.
111: * <PRE> mynewconstraint.setOffsetOfConstraint(-2000); </PRE>
112: * @param offset - of the Constraint
113: **/
114: void setOffsetOfConstraint(double offset);
115:
116: }
|