Package org.sakaiproject.cheftool.api
Interface Alert
-
public interface AlertAlert is a interface for a set of messages intended for user display in the user interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidadd(String alert)Add a new alert line.voidclear()Remove any messages in the Alert.StringgetAlert()Access the alert message.booleanisEmpty()Check to see if the alert is empty, or has been populated.StringpeekAlert()Access the alert message, but unlike getAlert(), do not clear the message.
-
-
-
Method Detail
-
add
void add(String alert)
Add a new alert line. A line separator will be appended as needed.- Parameters:
alert- The alert message to add.
-
getAlert
String getAlert()
Access the alert message. Once accessed, the message is cleared.- Returns:
- The alert message.
-
peekAlert
String peekAlert()
Access the alert message, but unlike getAlert(), do not clear the message.- Returns:
- The alert message.
-
isEmpty
boolean isEmpty()
Check to see if the alert is empty, or has been populated.- Returns:
- true of the alert is empty, false if there have been alerts set.
-
clear
void clear()
Remove any messages in the Alert.
-
-