org.openmrs.notification.impl

Class AlertServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.notification.impl.AlertServiceImpl

All Implemented Interfaces:

Serializable, OpenmrsService, AlertService

@Transactional
public class AlertServiceImpl
extends BaseOpenmrsService
implements Serializable, AlertService

This class should not be instantiated by itself.

See Also:

AlertService, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AlertServiceImpl() Default constructor

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 class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

AlertServiceImpl

public AlertServiceImpl()

Default constructor

Method Detail

setAlertDAO

public void setAlertDAO(AlertDAO dao)

Description copied from interface: AlertService

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

Specified by:

setAlertDAO in interface AlertService

Parameters:

dao - The dao implementation to use

See Also:

AlertService.setAlertDAO(org.openmrs.notification.db.AlertDAO)

saveAlert

public Alert saveAlert(Alert alert)
                throws APIException

Description copied from interface: AlertService

Save the given alert in the database

Specified by:

saveAlert in interface AlertService

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

See Also:

AlertService.saveAlert(org.openmrs.notification.Alert)

getAlert

@Transactional(readOnly=true)
public Alert getAlert(Integer alertId)
                                             throws APIException

Description copied from interface: AlertService

Get alert by internal identifier

Specified by:

getAlert in interface AlertService

Parameters:

alertId - internal alert identifier

Returns:

alert with given internal identifier

Throws:

APIException

See Also:

AlertService.getAlert(java.lang.Integer)

purgeAlert

public void purgeAlert(Alert alert)
                throws APIException

Description copied from interface: AlertService

Completely delete the given alert from the database

Specified by:

purgeAlert in interface AlertService

Parameters:

alert - the Alert to purge/delete

Throws:

APIException

See Also:

AlertService.purgeAlert(org.openmrs.notification.Alert)

getAllActiveAlerts

@Transactional(readOnly=true)
public List<Alert> getAllActiveAlerts(User user)
                                                             throws APIException

Description copied from interface: AlertService

Find all alerts for a user that have not expired

Specified by:

getAllActiveAlerts in interface AlertService

Returns:

alerts that are unread _or_ read that have not expired

Throws:

APIException

See Also:

AlertService.getAllActiveAlerts(org.openmrs.User)

getAlertsByUser

@Transactional(readOnly=true)
public List<Alert> getAlertsByUser(User user)
                                                          throws APIException

Description copied from interface: AlertService

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)

Specified by:

getAlertsByUser in interface AlertService

Parameters:

user - the user that is assigned to the returned alerts

Returns:

alerts that are unread and not expired

Throws:

APIException

See Also:

AlertService.getAlertsByUser(org.openmrs.User)

getAlerts

@Transactional(readOnly=true)
public List<Alert> getAlerts(User user,
                                                           boolean includeRead,
                                                           boolean includeExpired)
                                                    throws APIException

Description copied from interface: AlertService

Finds alerts for the given user with the given status

Specified by:

getAlerts in interface AlertService

Parameters:

user - to restrict to

Returns:

alerts for this user with these options

Throws:

APIException

See Also:

AlertService.getAlerts(org.openmrs.User, boolean, boolean)

getAllAlerts

@Transactional(readOnly=true)
public List<Alert> getAllAlerts()
                                                       throws APIException

Description copied from interface: AlertService

Get all unexpired alerts for all users

Specified by:

getAllAlerts in interface AlertService

Returns:

list of unexpired alerts

Throws:

APIException

See Also:

AlertService.getAllAlerts()

getAllAlerts

@Transactional(readOnly=true)
public List<Alert> getAllAlerts(boolean includeExpired)
                                                       throws APIException

Description copied from interface: AlertService

Get alerts for all users while obeying includeExpired

Specified by:

getAllAlerts in interface AlertService

Returns:

list of alerts

Throws:

APIException

See Also:

AlertService.getAllAlerts(boolean)

notifySuperUsers

public void notifySuperUsers(String messageCode,
                             Exception cause,
                             Object... messageArguments)

Description copied from interface: AlertService

Sends an alert to all superusers

Specified by:

notifySuperUsers in interface AlertService

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

See Also:

AlertService.notifySuperUsers(String, Exception, Object...)