org.openmrs.api

Interface ActiveListService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ActiveListServiceImpl

public interface ActiveListService
extends OpenmrsService

Contains generic methods pertaining to Active Lists in the system

See Also:

Context, Patient

Method Summary

Modifier and Type	Method and Description
<T extends ActiveListItem> T	getActiveListItem(Class<T> clazz, Integer activeListItemId) Returns the ActiveListItem
ActiveListItem	getActiveListItemByUuid(String uuid) Return the ActiveList by the UUID
<T extends ActiveListItem> List<T>	getActiveListItems(Class<T> clazz, Person p, ActiveListType type) Returns a sorted set of active list items from a class that extends ActiveListItem
List<ActiveListItem>	getActiveListItems(Person p, ActiveListType type) Returns a sorted set of active list items based on the type given.
void	purgeActiveListItem(ActiveListItem item) Completely removes an ActiveListItem from the database (not reversible)
ActiveListItem	removeActiveListItem(ActiveListItem item, Date endDate) Sets the Active List Item as inactive by setting the end date to today, if null
ActiveListItem	saveActiveListItem(ActiveListItem item) Save or update an Active List Item
void	setActiveListDAO(ActiveListDAO dao) Sets the DAO for this service.
ActiveListItem	voidActiveListItem(ActiveListItem item, String reason) Voids the Active List Item

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setActiveListDAO

void setActiveListDAO(ActiveListDAO dao)

Sets the DAO for this service. This is done by DI and Spring. See the applicationContext-service.xml definition file.

Parameters:

dao - DAO for this service

getActiveListItems

List<ActiveListItem> getActiveListItems(Person p,
                                        ActiveListType type)
                                 throws APIException

Returns a sorted set of active list items based on the type given.

Parameters:

p - the Person

type - Problem or Allergy

Returns:

sorted set based on the start date

Throws:

APIException

getActiveListItems

<T extends ActiveListItem> List<T> getActiveListItems(Class<T> clazz,
                                                      Person p,
                                                      ActiveListType type)
                                               throws APIException

Returns a sorted set of active list items from a class that extends ActiveListItem

Parameters:

clazz - extends ActiveListItem

p - the Person

type -

Returns:

sorted set based on the start date

Throws:

APIException

getActiveListItem

<T extends ActiveListItem> T getActiveListItem(Class<T> clazz,
                                               Integer activeListItemId)
                                        throws APIException

Returns the ActiveListItem

Parameters:

clazz - extends ActiveListItem

activeListItemId - the unique ID of the Active List

Returns:

active list item

Throws:

APIException

getActiveListItemByUuid

ActiveListItem getActiveListItemByUuid(String uuid)
                                throws APIException

Return the ActiveList by the UUID

Parameters:

uuid - unique identifier

Returns:

active list item

Throws:

APIException

saveActiveListItem

ActiveListItem saveActiveListItem(ActiveListItem item)
                           throws APIException

Save or update an Active List Item

Parameters:

item -

Returns:

the newly saved item

Throws:

APIException

removeActiveListItem

ActiveListItem removeActiveListItem(ActiveListItem item,
                                    Date endDate)
                             throws APIException

Sets the Active List Item as inactive by setting the end date to today, if null

Parameters:

item -

Returns:

the newly removed item

Throws:

APIException

voidActiveListItem

ActiveListItem voidActiveListItem(ActiveListItem item,
                                  String reason)
                           throws APIException

Voids the Active List Item

Parameters:

item -

Returns:

the newly voided item

Throws:

APIException

purgeActiveListItem

void purgeActiveListItem(ActiveListItem item)
                  throws APIException

Completely removes an ActiveListItem from the database (not reversible)

Parameters:

item - the ActiveListItem to completely remove from the database

Throws:

APIException

Since:

1.8.5, 1.9.2

Expected Behavior:

Should purge active list item from database