|
| |
|
| java.lang.Object
 org.cougaar.planning.ldm.plan.AlertImpl
| AlertImpl | | public class AlertImpl implements Alert,NewAlert(Code) | | Alert Implementation
Open issues -
what happens when no one is subscribed to listen for this alert
need an Alert type, otherwise all Alerts will go to all subscribers
|
| myAcknowledged | | protected boolean myAcknowledged(Code) | | |
| myResponseRequired | | protected boolean myResponseRequired(Code) | | |
| mySeverity | | protected int mySeverity(Code) | | |
| myType | | protected int myType(Code) | | |
| AlertImpl | | public AlertImpl()(Code) | | Constructor - takes no args
|
| AlertImpl | | public AlertImpl(String text, boolean operatorResponseRequired, AlertParameter[] parameterOptions, int severity, int type, UID uid)(Code) | | Constructor -
Parameters:
text - String
Parameters:
operatorResponseRequired - boolean
Parameters:
parameterOptions - AlertParameter[]
Parameters:
severity - int
Parameters:
uid - UID |
| getAcknowledged | | public boolean getAcknowledged()(Code) | | getAcknowledged - returns boolean indicating whether alert has been acknowledged
boolean |
| getAlertParameters | | public AlertParameter[] getAlertParameters()(Code) | | getAlertParameters - returns alert parameters associated with the alert
AlertParameter[] |
| getAlertText | | public String getAlertText()(Code) | | getAlertText - returns the display text for the alert
|
| getOperatorResponse | | public Object getOperatorResponse()(Code) | | getOperatorResponse - return the operator response to the alert
Object - operator response to the alert. May be null. |
| getOperatorResponseRequired | | public boolean getOperatorResponseRequired()(Code) | | getOperatorResponseRequired - return boolean indicating whether alert requires an
operator response.
boolean |
| getSeverity | | public int getSeverity()(Code) | | getSeverity - returns severity associated with the alert
int |
| getType | | public int getType()(Code) | | getType - returns alert type
int |
| getUID | | public UID getUID()(Code) | | getUID - get uid for the object
UID assigned to object |
| setAcknowledged | | public void setAcknowledged(boolean ack)(Code) | | setAcknowledged - sets boolean indicating whether alert has been acknowleged
BOZO - Definition of 'acknowledged' is fuzzy. I assume that an alert which
requires an operator response can not acknowledged without the response. I see
no code enforcing this behaviour.
Parameters:
ack - boolean |
| setAlertParameters | | public void setAlertParameters(AlertParameter[] params)(Code) | | setAlertParameters - sets the alert parameters associated with the alert
Parameters:
params - AlertParameter[] |
| setAlertText | | public void setAlertText(String alertText)(Code) | | setAlertText - sets display text for the alert
|
| setOperatorResponse | | public void setOperatorResponse(Object response)(Code) | | setOperatorResponse - set the operator response to the alert
Parameters:
response - Object |
| setOperatorResponseRequired | | public void setOperatorResponseRequired(boolean req)(Code) | | setOperatorResponseRequired - sets boolean indicating whether alert requires an
operator response.
boolean |
| setSeverity | | public void setSeverity(int severity)(Code) | | setSeverity - sets severity associated with the alert
BOZO - This should be checking against defined severity values.
Parameters:
severity - int |
| setType | | public void setType(int type)(Code) | | setType - sets alert type
BOZO - Should be checking against some set of valid types.
Parameters:
type - int |
| setUID | | public void setUID(UID uid)(Code) | | setUID - set uid for the object
Why is this public? Does it make sense to allow random changes to
UID?
Parameters:
uid - UID assigned to object |
| validSeverity | | public boolean validSeverity(int severity)(Code) | | validSeverity - checks whether severity is valid.
MIN_SEVERITY and MAX_SEVERITY used to check for valid severity values.
Simple minded but works so long as we can keep a contiguous set of severities.
Parameters:
severity - int to be tested boolean true if valid severity, else false |
|
|
|