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: /** AlertParameter interface
30: *
31: *
32: * BOZO - Use of AlertParameter is not clearly defined. Object will probably change
33: * when we attempt to actually use it.
34: **/
35:
36: public interface AlertParameter extends java.io.Serializable {
37:
38: /**
39: * An object whose contents would be meaningful to a UI user who must
40: * respond to the Alert that this AlertParameter is part of.
41: **/
42: Object getParameter();
43:
44: /**
45: * A description of the AlertParameter for display in the UI to tell
46: * a user what and why he is seeing it.
47: **/
48: String getDescription();
49:
50: /**
51: * The answer to the question posed by this AlertParameter. This method
52: * would be used by the UI to fill in the user's response, if any.
53: **/
54: Object getResponse();
55:
56: /**
57: * Should this parameter be visible. Invisible parameters simply
58: * carry information needed to handle the alert when it is
59: * acknowledged.
60: **/
61: boolean isVisible();
62:
63: /**
64: * Should this parameter be editable. Uneditable parameters simply
65: * supply additional information to the operator, but the operator
66: * can't change them.
67: **/
68: boolean isEditable();
69: }
|