org.openmrs.notification

Interface AlertService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

AlertServiceImpl

public interface AlertService
extends OpenmrsService

Contains methods pertaining to creating/deleting/voiding Alerts in the system Use:

   Alert alert = new Alert();
   alert.set___(___);
   ...etc
   Context.getAlertService().saveAlert(alert);
 

Method Summary

Modifier and Type	Method and Description
Alert	getAlert(Integer alertId) Get alert by internal identifier
List<Alert>	getAlerts(User user, boolean includeRead, boolean includeExpired) Finds alerts for the given user with the given status
List<Alert>	getAlertsByUser(User user) Find the alerts that are not read and have not expired for a user This will probably be the most commonly called method If null is passed in for user, find alerts for the currently authenticated user.
List<Alert>	getAllActiveAlerts(User user) Find all alerts for a user that have not expired
List<Alert>	getAllAlerts() Get all unexpired alerts for all users
List<Alert>	getAllAlerts(boolean includeExpired) Get alerts for all users while obeying includeExpired
void	notifySuperUsers(String messageCode, Exception cause, Object... messageArguments) Sends an alert to all superusers
void	purgeAlert(Alert alert) Completely delete the given alert from the database
Alert	saveAlert(Alert alert) Save the given alert in the database
void	setAlertDAO(AlertDAO dao) Used by Spring to set the specific/chosen database access implementation

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setAlertDAO

void setAlertDAO(AlertDAO dao)

Used by Spring to set the specific/chosen database access implementation

Parameters:

dao - The dao implementation to use

saveAlert

@Authorized(value="Manage Alerts")
Alert saveAlert(Alert alert)
                                            throws APIException

Save the given alert in the database

Parameters:

alert - the Alert object to save

Returns:

The saved alert object

Throws:

APIException - Should save simple alert with one user Should save alerts by role Should assign uuid to alert

getAlert

@Authorized
Alert getAlert(Integer alertId)
                    throws APIException

Get alert by internal identifier

Parameters:

alertId - internal alert identifier

Returns:

alert with given internal identifier

Throws:

APIException

purgeAlert

@Authorized(value="Manage Alerts")
void purgeAlert(Alert alert)
                                            throws APIException

Completely delete the given alert from the database

Parameters:

alert - the Alert to purge/delete

Throws:

APIException

getAllActiveAlerts

@Authorized
List<Alert> getAllActiveAlerts(User user)
                                    throws APIException

Find all alerts for a user that have not expired

Parameters:

user -

Returns:

alerts that are unread _or_ read that have not expired

Throws:

APIException

See Also:

getAlerts(User, boolean, boolean)

getAlertsByUser

@Authorized
List<Alert> getAlertsByUser(User user)
                                 throws APIException

Find the alerts that are not read and have not expired for a user This will probably be the most commonly called method If null is passed in for user, find alerts for the currently authenticated user. If no user is authenticated, search on "new User()" (for "Anonymous" role alert possibilities)

Parameters:

user - the user that is assigned to the returned alerts

Returns:

alerts that are unread and not expired

Throws:

APIException

getAlerts

@Authorized
List<Alert> getAlerts(User user,
                                  boolean includeRead,
                                  boolean includeExpired)
                           throws APIException

Finds alerts for the given user with the given status

Parameters:

user - to restrict to

includeRead -

includeExpired -

Returns:

alerts for this user with these options

Throws:

APIException

getAllAlerts

@Authorized
List<Alert> getAllAlerts()
                              throws APIException

Get all unexpired alerts for all users

Returns:

list of unexpired alerts

Throws:

APIException

getAllAlerts

@Authorized
List<Alert> getAllAlerts(boolean includeExpired)
                              throws APIException

Get alerts for all users while obeying includeExpired

Parameters:

includeExpired -

Returns:

list of alerts

Throws:

APIException

notifySuperUsers

@Authorized(value="Manage Alerts")
void notifySuperUsers(String messageCode,
                                                         Exception cause,
                                                         Object... messageArguments)

Sends an alert to all superusers

Parameters:

messageCode - The alert message code from messages.properties

cause - The exception that was thrown, method will work if cause is null

messageArguments - The arguments for the coded message Should add an alert with message of length equals Text Max Length Should add an alert with message text if cause is null Should add an alert to the database