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: /**
30: * Allocation Interface
31: * An Allocation is a type of PlanElement
32: * which represents the Asset that will complete
33: * the Task.
34: */
35: public interface Allocation extends PlanElement {
36:
37: /** Returns an Asset that has certain capabilities.
38: * This Asset is assigned to complete the Task that is
39: * matched with the Allocation in the PlanElement.
40: *
41: * @return Asset - a physical entity or agent that is assigned to perform the Task.
42: **/
43: org.cougaar.planning.ldm.asset.Asset getAsset();
44:
45: /** Checks to see if there is a potential conflict with another allocation
46: * or asset transfer involving the same asset.
47: * Will return true if there is a potential conflict.
48: * Will return false if there is NOT a potential conflict.
49: * @return boolean
50: */
51: boolean isPotentialConflict();
52:
53: /** Checks to see if there is a potential conflict with the asset's
54: * available schedule. ( Asset.getRoleSchedule().getAvailableSchedule() )
55: * Will return true if there is a potential conflict.
56: * @return boolean
57: */
58: boolean isAssetAvailabilityConflict();
59:
60: /** Check to see if this allocation is Stale and needs to be revisited.
61: * Will return true if it is stale (needs to be revisted)
62: * @return boolean
63: */
64: boolean isStale();
65:
66: /** Set the stale flag. Usualy used by Trigger actions.
67: * @param stalestate
68: */
69: void setStale(boolean stalestate);
70:
71: /** Return the Role that the Asset is performing while executing
72: * this PlanElement (Task).
73: *
74: * @return Role
75: **/
76: Role getRole();
77: }
|