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 org.cougaar.core.util.UniqueObject;
30:
31: /** Alert interface
32: **/
33: public interface Alert extends UniqueObject {
34:
35: /**
36: * Text to be displayed by UI to explain the Alert to the user.
37: **/
38: String getAlertText();
39:
40: /**
41: * Parameters that contain objects to be acted upon, or chosen from among
42: **/
43: AlertParameter[] getAlertParameters();
44:
45: /**
46: * Indicates whether the Alert has been acted upon
47: **/
48: boolean getAcknowledged();
49:
50: int UNDEFINED_SEVERITY = -1;
51: int LOW_SEVERITY = 0;
52: int MEDIUM_SEVERITY = 1;
53: int HIGH_SEVERITY = 2;
54:
55: // MIN_SEVERITY and MAX_SEVERITY used to check for valid severity values.
56: // Simple minded but works so long as we can keep a contiguous set of severities.
57: int MIN_SEVERITY = UNDEFINED_SEVERITY;
58: int MAX_SEVERITY = HIGH_SEVERITY;
59:
60: /**
61: * Indicates Alert severity
62: * Should be one of the values defined above.
63: */
64: int getSeverity();
65:
66: int UNDEFINED_TYPE = -1;
67: int CONSUMPTION_DEVIATION_TYPE = 5;
68:
69: /**
70: * Indicates Alert type.
71: * BOZO - I presume this means the type of activity which generated the alert -
72: * transportation, ... Valid types should be defined within the interface ala
73: * severities but I haven't a clue what they might be.
74: */
75: int getType();
76:
77: /**
78: * Indicates whether UI user is required to take action on this alert
79: **/
80: boolean getOperatorResponseRequired();
81:
82: /**
83: * The answer to the Alert. The AlertParameters can also have responses
84: **/
85: Object getOperatorResponse();
86: }
|